Mod-Description-Template

Looking for a mod? Have a review on a mod you'd like to share?
Locked
User avatar
ssilk
Global Moderator
Global Moderator
Posts: 12888
Joined: Tue Apr 16, 2013 10:35 pm
Contact:

Mod-Description-Template

Post by ssilk »

.



This is under discussion! Please look into the Mod-Header Discussion!



This is the try to introduce nicer, standardized, machine-readable and more useful mod-descriptions.
Please discuss this in the Mod-discussion board

The mod-description has two parts, a header and a body - exactly like Hypertext Transfer Protocol.
The header-names are not upper/lower-case-sensitive. A header can be only one line.
Between header and body there must be a blank line, like HTTP.
More can follow in the body, but that is not bounded to a form. Spoilers can/should be used to hide not not so interesting part.
Any heading here can be used...

Please press SELECT ALL, then copy/paste this:

Code: Select all

Type: Mod
Name: Fancy transports
Description: Adding some UI stuff for transportation <(max. 140 chars)
License: Link to a license or very short text description
Version: 1.0.2
Release: 2015-07-23
Tested-With-Factorio-Version: 0.12.0
Category: (One of Alpha, Helper, Item, SimpleExtension, Gameplay, Convenience, Compilation, CompleteOverhaul, ModPack, Lib, Other)
Tags: Free, comma separated (E. g. Textures, User-Interface, Vehicles, fancy tag name)
Download-Url: [url]http://Direct-download-Url[/url]
Website: [url]http://some project page[/url]

[spoiler=License][size=150]License[/size]
This text should be a copy of the licence in the mod.
Long description/Text of license/Links and especially (usefully at the top) what that means for
using in modpacks; using graphics/sounds/code or other parts in other mods;
taking mod over when orphaned; ... [/spoiler]

[spoiler=Long description][size=150]Long description[/size]
Can also include pictures. This can be also some kind of docs.[/spoiler]

[spoiler=Pictures][size=150]Pictures[/size]
[img][/img] ...
[/spoiler]

[spoiler=Version history][size=150]Version history[/size]
Version# (Date): What has changed...[/spoiler]

[spoiler=Create own paragraphs as you like][size=150]Create own paragraphs as you like[/size]
[/spoiler]
This will look then like so:

Type: Mod
Name: Fancy transports
Description: Adding some UI stuff for transportation <(max. 140 chars)
License: Link to a license or very short text description
Version: 1.0.2
Release: 2015-07-23
Tested-With-Factorio-Version: 0.12.0
Category: (One of Alpha, Helper, Item, SimpleExtension, Gameplay, Convenience, Compilation, CompleteOverhaul, ModPack, Lib, Other)
Tags: Free, comma separated (E. g. Textures, User-Interface, Vehicles, fancy tag name)
Download-Url: http://Direct-download-Url
Website: [url]http://some%20project%20page[/url]
License
Long description
Pictures
Version history
Create own paragraphs as you like
Cool suggestion: Eatable MOUSE-pointers.
Have you used the Advanced Search today?
Need help, question? FAQ - Wiki - Forum help
I still like small signatures...

Locked

Return to “Questions, reviews and ratings”