Difference between revisions of "Modding Etiquette"
→Documentation
imported>Wrye (First draft) |
imported>Wrye |
||
| Line 18: | Line 18: | ||
=== Include Version Number=== | === Include Version Number=== | ||
Include a line in the description specifying the version number like so "Version: 1.03". This makes it easy for users to know which version number they're using. Also Wrye Bash's mod list includes such version numbers in the mod lists it generates, which helps other users to diagnose problems with mod lists. | Include a line in the description specifying the version number like so "Version: 1.03". This makes it easy for users to know which version number they're using. Also Wrye Bash's mod list includes such version numbers in the mod lists it generates, which helps other users to diagnose problems with mod lists. | ||
==Documentation== | |||
Include a detailed '''Readme''' file along with your mod. A good readme provides a description of the mod's features, any potential bugs or technical issues, a list of changes made to existing objects, possible sources of conflict with other mods, and some information on how to contact you in the event that a user encounters a problem with your plugin. Creating the readme as a plain text file (such as one written in Notepad) ensures that everyone will be able to read it. And to avoid overwriting another mod's readme, give it a unique name, such as "YourModName - Readme!" | |||
* Here's a sample [http://www.tessource.net/files/file.php?id=4793 readme template] (modder's resource) that includes instructions for how to best deal with ArchiveInvalidation problems. | |||
* You can also use the [http://lhammonds.game-host.org/obmm/tools_readme_generator1.asp Readme Generator] to quickly build a custom-tailored and professional-looking text file with very little effort. | |||
* Alternatively, [http://wrye.ufrealms.net/#WryeBash Wrye Bash] (0.42 or later) has readme templates and [http://wrye.ufrealms.net/Wrye%20Bash.html#WikiTextFormat wikitext to html conversion] built in. | |||
== Packaging == | == Packaging == | ||