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

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
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?



Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.
Code: Select all
mymod/
 - init.lua
 - description.txt
 - screenshot.png


Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.
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.

Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.
Code: Select all
Adds email style inboxes to Minetest.
Users can send stored messages to each other using /inbox or /mail username message.

Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.
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.
 

User avatar
MineYoshi
Member
 
Posts: 4267
Joined: Wed Jul 08, 2015 13:20
GitHub: MineYosh
IRC: MineYoshi
In-game: Kirby_Retro

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...
People talk about freedom of speech, so i'll say that God exists.
Open your eyes!! See The big unicorn conspiracy.!! :D The government has been lying to us about unicorns!!
"I've learned there are three things you don't discuss with people: religion, politics and the Great Pumpkin" - Linus Van Pelt
I'm the Officially 1st ABJist in the world ( ͡° ͜ʖ ͡°)
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
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.
 

User avatar
MineYoshi
Member
 
Posts: 4267
Joined: Wed Jul 08, 2015 13:20
GitHub: MineYosh
IRC: MineYoshi
In-game: Kirby_Retro

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

by MineYoshi » Fri Mar 18, 2016 01:16

OK, THX for the explanation!

=D
People talk about freedom of speech, so i'll say that God exists.
Open your eyes!! See The big unicorn conspiracy.!! :D The government has been lying to us about unicorns!!
"I've learned there are three things you don't discuss with people: religion, politics and the Great Pumpkin" - Linus Van Pelt
I'm the Officially 1st ABJist in the world ( ͡° ͜ʖ ͡°)
 

User avatar
Don
Member
 
Posts: 1641
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: 1641
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
Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.
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: 4267
Joined: Wed Jul 08, 2015 13:20
GitHub: MineYosh
IRC: MineYoshi
In-game: Kirby_Retro

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

by MineYoshi » Mon Mar 21, 2016 17:07

+10

Great idea Don!
People talk about freedom of speech, so i'll say that God exists.
Open your eyes!! See The big unicorn conspiracy.!! :D The government has been lying to us about unicorns!!
"I've learned there are three things you don't discuss with people: religion, politics and the Great Pumpkin" - Linus Van Pelt
I'm the Officially 1st ABJist in the world ( ͡° ͜ʖ ͡°)
 

User avatar
addi
Member
 
Posts: 605
Joined: Thu Sep 20, 2012 03:16

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
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
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.
 

User avatar
benrob0329
Member
 
Posts: 1192
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: 4267
Joined: Wed Jul 08, 2015 13:20
GitHub: MineYosh
IRC: MineYoshi
In-game: Kirby_Retro

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!)
People talk about freedom of speech, so i'll say that God exists.
Open your eyes!! See The big unicorn conspiracy.!! :D The government has been lying to us about unicorns!!
"I've learned there are three things you don't discuss with people: religion, politics and the Great Pumpkin" - Linus Van Pelt
I'm the Officially 1st ABJist in the world ( ͡° ͜ʖ ͡°)
 

User avatar
azekill_DIABLO
Member
 
Posts: 3458
Joined: Wed Oct 29, 2014 20:05
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
Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.
Code: Select all
Hi, my username is azekill_DIABLO and i'm an exelent bug-maker(yeah...i know...i have a bad reputation)

azekill_DIABLO said: Mineyoshi+ABJ+Baggins= TOPIC HIJACKED.
My Mods and Stuff | Voxellar | VoxBox on GITHUB | M.I.L.A Monster engine
WEIRD MODDING CONTEST !!!
 

User avatar
rubenwardy
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
GitHub: rubenwardy
IRC: rubenwardy
In-game: rubenwardy

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

by rubenwardy » Sun May 29, 2016 13:29

public service announcement
 

User avatar
addi
Member
 
Posts: 605
Joined: Thu Sep 20, 2012 03:16

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
Member
 
Posts: 4500
Joined: Tue Jun 12, 2012 18:11
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
 

BBmine
Member
 
Posts: 1425
Joined: Sun Jul 12, 2015 22:51
GitHub: BBmine
IRC: BBmine
In-game: Baggins

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

by BBmine » Sun Mar 19, 2017 01:20

I don't put pics or descriptions in my mods.... I guess I should.
God's not dead!
I actually did mine walls before I started playing this game....
Mods, Servers, and My Youtube Channel
Let us remember Just Test on April 16.
"Together, we will make America great again!" --President Trump
Please vote for the next video I should do here
I'm the most rottenist potato in the fridge.
Copyright (c) 2017 Baggins Inc. (tm) All rights reserved.
 


Return to Modding Discussion

Who is online

Users browsing this forum: No registered users and 16 guests

cron