description.txt and screenshot.png in mod/modpack.

User avatar
rubenwardy
Moderator
 
Posts: 5428
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

description.txt and screenshot.png in mod/modpack.

by rubenwardy » Thu Mar 17, 2016 14:55

A lot of mods don't seem to have description.txt and/or screenshot.png in their root folder. These files are used by mod managers, both ingame and external, to show concise information to the user.

Where?



Code: Select all
mymod/
 - init.lua
 - description.txt
 - screenshot.png


Code: Select all
mp_mymods/
 - description.txt
 - screenshot.png
 - mymod/
     - init.lua
     - description.txt
     - screenshot.png


Screenshots and descriptions in modpacks aren't as important, but would be nice.
Not all mods need a screenshot, ofc.

Description



The first sentence of description.txt should be less than 100 characters.
It should be enough to describe the mod. Further information can be put into other sentences.

Code: Select all
Adds email style inboxes to Minetest.
Users can send stored messages to each other using /inbox or /mail username message.

Code: Select all
Allows players to report misconduct or bugs using /report.


If you want to put versions or licenses, put them at the end. I don't recommend it though, that info should probably be in the readme.md/txt. Don't include the entire text of a license.

Screenshot



Screenshot should be 3:2 with a minimum size of 300x200px.
Last edited by rubenwardy on Sun May 29, 2016 15:09, edited 1 time in total.
Core Developer | Donate | My Twitter | Mods | Mods 4 Android | Node Box Editor | Minetest Modding Book

Hello profile reader

LgiOxMFYXOqtqVqMPhbw1Bn3oNRvEC7j
 

User avatar
MineYoshi
Member
 
Posts: 5350
Joined: Wed Jul 08, 2015 13:20

Re: PSA: description.txt and screenshot.png in mod/modpack.

by MineYoshi » Thu Mar 17, 2016 19:42

Exactly what mod managers?

I don't know about that...
beti PHPen programatzen ari naiz.
 

User avatar
rubenwardy
Moderator
 
Posts: 5428
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: PSA: description.txt and screenshot.png in mod/modpack.

by rubenwardy » Thu Mar 17, 2016 23:35

I'm posting this mainly because of http://rubenwardy.com/mtmods4android/

But it's also used by minetest-bower, mtpm and the mod tab in the main menu.
Core Developer | Donate | My Twitter | Mods | Mods 4 Android | Node Box Editor | Minetest Modding Book

Hello profile reader

LgiOxMFYXOqtqVqMPhbw1Bn3oNRvEC7j
 

User avatar
MineYoshi
Member
 
Posts: 5350
Joined: Wed Jul 08, 2015 13:20

Re: PSA: description.txt and screenshot.png in mod/modpack.

by MineYoshi » Fri Mar 18, 2016 01:16

OK, THX for the explanation!

=D
beti PHPen programatzen ari naiz.
 

User avatar
Don
Member
 
Posts: 1642
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: PSA: description.txt and screenshot.png in mod/modpack.

by Don » Sun Mar 20, 2016 04:01

Sounds great. i was also thinking of making a topic about this. Glad to see you have already done it
Many of my mods are now a part of Minetest-mods. A place where you know they are maintained!

A list of my mods can be found here
 

User avatar
Don
Member
 
Posts: 1642
Joined: Sat May 17, 2014 18:40
GitHub: DonBatman
IRC: Batman
In-game: Batman

Re: PSA: description.txt and screenshot.png in mod/modpack.

by Don » Sun Mar 20, 2016 15:54

There should also be a mod.conf file. This file contains the name of the mod. If the mod has this file the engine reads this instead of the folder name. This means that people do not need to rename folders such as mymod-master --> mymod.

This should be like this

mod.conf
Code: Select all
name = mod_name
Many of my mods are now a part of Minetest-mods. A place where you know they are maintained!

A list of my mods can be found here
 

User avatar
MineYoshi
Member
 
Posts: 5350
Joined: Wed Jul 08, 2015 13:20
 

User avatar
addi
Member
 
Posts: 634
Joined: Thu Sep 20, 2012 03:16
Location: Black-Forest, Germany
GitHub: adrido

Re: PSA: description.txt and screenshot.png in mod/modpack.

by addi » Tue Mar 22, 2016 06:59

About your Article:
Pretty good, and contains everything someone want to know.
But what's the meaning of PSA and OFC?
I tried to search for it, but I was not successful. (PSA OFC = office???)

About the screenshot.png:
The screenshot format 3:2 is very uncommon. Also the screenshot inside Minetest is displayed so small that you are not able to see something useful here. (except you only show a single node there)

About description.txt:
In the description.txt you are only able to select a whole line. Not a single word sentence or link. Also its not possible to copy it to clipboard and paste it in the browser. As long as Minetest does not provide something real there Ill not add a real descriptions to my mods.
 

User avatar
rubenwardy
Moderator
 
Posts: 5428
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: PSA: description.txt and screenshot.png in mod/modpack.

by rubenwardy » Tue Mar 22, 2016 07:22

PSA = public service announcement
Ofc = of course

I did not decide the format, apparently it was to use horizontal space. The description is for a description, not to contain a help file or excessive links in my opinion.
Core Developer | Donate | My Twitter | Mods | Mods 4 Android | Node Box Editor | Minetest Modding Book

Hello profile reader

LgiOxMFYXOqtqVqMPhbw1Bn3oNRvEC7j
 

User avatar
benrob0329
Member
 
Posts: 1233
Joined: Thu Aug 06, 2015 22:39
GitHub: Benrob0329
In-game: benrob03

Re: PSA: description.txt and screenshot.png in mod/modpack.

by benrob0329 » Tue Mar 22, 2016 14:01

The description is similar to that on Linux package managers, it's just meant to be a one liner describing the basic purpose of the mod.

At least, As far as I can tell.
 

User avatar
MineYoshi
Member
 
Posts: 5350
Joined: Wed Jul 08, 2015 13:20

Re: PSA: description.txt and screenshot.png in mod/modpack.

by MineYoshi » Tue Mar 22, 2016 22:28

Well, the description should be something short, simple and understandable, explaining what does the mode, something like that:

Benrob0329 Mod:
[code = "Description"]
This mod adds benrob mobs to the Minetest Game, they are peaceful and give you a laughing cat avatar if you give him a CC-BY-C0 License document.
Created by: benrob0329[/code]

Maybe something like that?

(Benrob0329s everywhere!)
beti PHPen programatzen ari naiz.
 

User avatar
azekill_DIABLO
Member
 
Posts: 7390
Joined: Wed Oct 29, 2014 20:05
Location: Under my desk (but I can't see my monitor now X'[ )
GitHub: azekillDIABLO
In-game: azekill_DIABLO

Re: PSA: description.txt and screenshot.png in mod/modpack.

by azekill_DIABLO » Sun May 29, 2016 09:19

addi wrote:About your Article:
Pretty good, and contains everything someone want to know.
But what's the meaning of PSA and OFC?
I tried to search for it, but I was not successful. (PSA OFC = office???)


found waht is PSA: Prostate-specific antigen
【OMICRON】 ; 【MILA】 update ; 【BB,HD】 update ; 【▶ Youtube】 Redstone will be added in 20 months ago. -wuzzy
 

User avatar
rubenwardy
Moderator
 
Posts: 5428
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy
 

User avatar
addi
Member
 
Posts: 634
Joined: Thu Sep 20, 2012 03:16
Location: Black-Forest, Germany
GitHub: adrido

Re: PSA: description.txt and screenshot.png in mod/modpack.

by addi » Sun May 29, 2016 14:02

And what do we learn from this story?
Avoid unclear/uncommon abbreviations in a international community. ;-)
 

User avatar
rubenwardy
Moderator
 
Posts: 5428
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: PSA: description.txt and screenshot.png in mod/modpack.

by rubenwardy » Sun May 29, 2016 15:08

It really doesn't matter that much, focus on the content of this article and correcting your mods rather than the title
Core Developer | Donate | My Twitter | Mods | Mods 4 Android | Node Box Editor | Minetest Modding Book

Hello profile reader

LgiOxMFYXOqtqVqMPhbw1Bn3oNRvEC7j
 

User avatar
BBmine
Member
 
Posts: 3410
Joined: Sun Jul 12, 2015 22:51
Location: USA
IRC: BBmine
In-game: Baggins
 

sofar
Developer
 
Posts: 1653
Joined: Fri Jan 16, 2015 07:31
GitHub: sofar
IRC: sofar
In-game: sofar

Re: description.txt and screenshot.png in mod/modpack.

by sofar » Sun Dec 24, 2017 06:42

Can you also include `mod.conf` in the OP? Seems missing in a lot of mods as well.
 

User avatar
ChimneySwift
Member
 
Posts: 260
Joined: Fri Sep 22, 2017 06:46
Location: 127.0.0.1
GitHub: ChimneySwift
IRC: ChimneySwift
In-game: ChimneySwift

Re: description.txt and screenshot.png in mod/modpack.

by ChimneySwift » Mon Dec 25, 2017 08:30

Hmm, I always include description.txt AFAIK, but sometimes screenshot.png doesn't really fit (like if a command is added)
"You have to be a pretty sad person to quote yourself" ~ ChimneySwift
 

User avatar
Linuxdirk
Member
 
Posts: 1553
Joined: Wed Sep 17, 2014 11:21
Location: Germany
In-game: Linuxdirk

Re: description.txt and screenshot.png in mod/modpack.

by Linuxdirk » Mon Dec 25, 2017 12:05

sofar wrote:Can you also include `mod.conf` in the OP? Seems missing in a lot of mods as well.

Is there already anything except name (what actually defines the prefix/ID instead of the name that’s displayed in mod selection or advanced configuration) supported?
 

sofar
Developer
 
Posts: 1653
Joined: Fri Jan 16, 2015 07:31
GitHub: sofar
IRC: sofar
In-game: sofar

Re: description.txt and screenshot.png in mod/modpack.

by sofar » Tue Dec 26, 2017 00:11

Linuxdirk wrote:
sofar wrote:Can you also include `mod.conf` in the OP? Seems missing in a lot of mods as well.

Is there already anything except name (what actually defines the prefix/ID instead of the name that’s displayed in mod selection or advanced configuration) supported?


Not by the engine. There are some other tools that read it, but since no documented standard exists, those might break or conflict.
 

User avatar
Linuxdirk
Member
 
Posts: 1553
Joined: Wed Sep 17, 2014 11:21
Location: Germany
In-game: Linuxdirk

Re: description.txt and screenshot.png in mod/modpack.

by Linuxdirk » Tue Dec 26, 2017 08:18

sofar wrote:Not by the engine. There are some other tools that read it, but since no documented standard exists, those might break or conflict.

If this ever changes (there are multiple good reasons to do this and show the information in the client) I’ll consider mod.conf as relevant. Right now I just use it to set the ID of the mod using the name key.
 

User avatar
sorcerykid
Member
 
Posts: 773
Joined: Fri Aug 26, 2016 15:36
Location: Illinois, USA
GitHub: sorcerykid
In-game: Nemo

Re: description.txt and screenshot.png in mod/modpack.

by sorcerykid » Tue Dec 26, 2017 13:42

It seems peculiar that the description wouldn't also be contained in mod.conf, but is instead read from a separate description.txt file O_o

I think it would be sensible if dependencies were included too, so everything needed to install the mod is consolidated in one master file.

Here is just one idea of how an expanded mod.conf might look:

mod.conf
name = My Farming Mod
description = a great mod for useful farming tools
version = 1.0 beta
author = supermodder
copyright = Copyright (c) 2017, supermodder
depends = default, farming

Of course, all of the fields are optional except name and description.
Last edited by sorcerykid on Tue Dec 26, 2017 13:52, edited 1 time in total.
 

User avatar
Linuxdirk
Member
 
Posts: 1553
Joined: Wed Sep 17, 2014 11:21
Location: Germany
In-game: Linuxdirk

Re: description.txt and screenshot.png in mod/modpack.

by Linuxdirk » Tue Dec 26, 2017 13:47

sorcerykid wrote:It seems peculiar that the description wouldn't also be contained in mod.conf, but is instead read from a separate description.txt file O_o

Which is okay, because the description can be very long. But there should be something like tagline in the mod.conf file that can be used to provide a very short description (8-10 words) that is shown in the mod overview list.

Or author, version, website, name (actual name of the mod instead of the id which should go under the id key), dependencies (depends, conflicts, optional) ... This file has a lot of potential. It’s apity that it is not used at all except for the ID.
 

User avatar
rubenwardy
Moderator
 
Posts: 5428
Joined: Tue Jun 12, 2012 18:11
Location: United Kingdom
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

Re: description.txt and screenshot.png in mod/modpack.

by rubenwardy » Tue Dec 26, 2017 13:54

Mod.conf was added after depends.txt, and in the future depends.txt will be deprecated in favour of depends in mod.conf. Same for description

I have a WIP PR on Github for this
Core Developer | Donate | My Twitter | Mods | Mods 4 Android | Node Box Editor | Minetest Modding Book

Hello profile reader

LgiOxMFYXOqtqVqMPhbw1Bn3oNRvEC7j
 

User avatar
sorcerykid
Member
 
Posts: 773
Joined: Fri Aug 26, 2016 15:36
Location: Illinois, USA
GitHub: sorcerykid
In-game: Nemo
 

Next

Return to Modding Discussion



Who is online

Users browsing this forum: Joseph13 and 2 guests