Modding Standards

Post Reply
User avatar
SonosFuer
Member
Posts: 104
Joined: Sun Jul 09, 2017 00:32
GitHub: apachano
IRC: SonosFuer
In-game: SonosFuer

Modding Standards

by SonosFuer » Post

Hello all,

I am looking into standard files to include for modding, so far I have scoured the forums for some information as well as looked at many mods to see what they are doing.

RubenWardy includes some basics in his modding tutorial book. https://rubenwardy.com/minetest_modding ... lders.html

This post goes over a lot of things that I find interesting viewtopic.php?f=47&t=14224

My reasoning for going over this is I am building a sub-game and I want to automatically collect information from the mods I am including, for example credit, licenses, and API information. So with giving credit for resources and code I want a script to look through each mod and gather all of that information to store in a single file for the sub-game, same with the API concept. This could be really useful for other purposes such as mod managers being able to pull information and potentially minetest itself using it.

I have gone over some files I have learned about below

depends.txt
This lists dependencies, it already has a standard format and is used by the engine.
readme.md
Mostly important if you are using github
description.txt
RubenWardy mentions this in his post
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.
screenshot.png
RubenWardy mentions this in his post
Screenshot should be 3:2 with a minimum size of 300x200px.
mod.conf
Don mentions this in RubenWardy's post viewtopic.php?f=47&t=14224#p211259
Only states the name of the mod, used by the engine
sorcerykid suggested extending this in RubenWardy's post viewtopic.php?f=47&t=14224#p305622
api.txt
Seen in multiple mods such as mobs_redo
No standard format and generally not able to be automatically read from. (I want to automatically compile an API list for my sub game, could have other benefits as well such as being usable in an IDE plugin)
Settingtypes.txt
File contains mods settings displayed in the settings menu.
http://dev.minetest.net/settingtypes.txt

It would be really cool if some standard practices were put together in a guide. I could easily document the information although I feel RubenWardy's Modding tutorial book would be the best home (I could also compile the information and make a pull request amending it.) I need some help figuring out the best way to do this is and need to figure out if anyone else thinks this would be useful. More importantly I need to figure out what would be useful to try to attempt to standardize.
Last edited by SonosFuer on Thu Feb 08, 2018 03:36, edited 2 times in total.
Working on a content database for minetest mods, servers, and etc Check it out and give me feedback at viewtopic.php?f=14&t=18137

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

Re: Modding Standards

by rubenwardy » Post

screenshot.png and mod.conf are in the releasing mods chapter: https://rubenwardy.com/minetest_modding ... asing.html
Should probably be mentioned in the folder chapter however
Renewed Tab (my browser add-on) | Donate | Mods | Minetest Modding Book

Hello profile reader

User avatar
SonosFuer
Member
Posts: 104
Joined: Sun Jul 09, 2017 00:32
GitHub: apachano
IRC: SonosFuer
In-game: SonosFuer

Re: Modding Standards

by SonosFuer » Post

rubenwardy wrote:screenshot.png and mod.conf are in the releasing mods chapter: https://rubenwardy.com/minetest_modding ... asing.html
Should probably be mentioned in the folder chapter however
That's good! I guess I overlooked that when writing this post. I would still like to see some further documentation on what else would be best to be included such as an apt.txt and more on mod.conf
Working on a content database for minetest mods, servers, and etc Check it out and give me feedback at viewtopic.php?f=14&t=18137

User avatar
Pyrollo
Developer
Posts: 385
Joined: Mon Jan 08, 2018 15:14
GitHub: pyrollo
In-game: Naj
Location: Paris

Re: Modding Standards

by Pyrollo » Post

I think you can add settingtypes.txt file to the list:
Settingtypes.txt files contains mods settings displayed in the settings menu.

Settings can be accessed with minetest.setting_get method.
(see http://dev.minetest.net/settingtypes.txt)
[ Display Modpack ] - [ Digiterms ] - [ Crater MG ] - [ LATE ]

User avatar
SonosFuer
Member
Posts: 104
Joined: Sun Jul 09, 2017 00:32
GitHub: apachano
IRC: SonosFuer
In-game: SonosFuer

Re: Modding Standards

by SonosFuer » Post

Pyrollo wrote:I think you can add settingtypes.txt file to the list:
Settingtypes.txt files contains mods settings displayed in the settings menu.

Settings can be accessed with minetest.setting_get method.
(see http://dev.minetest.net/settingtypes.txt)
Thank you, I added it to the list.
Working on a content database for minetest mods, servers, and etc Check it out and give me feedback at viewtopic.php?f=14&t=18137

Post Reply

Who is online

Users browsing this forum: No registered users and 8 guests