Difference between revisions of "Modding Etiquette"
→Documentation
imported>Wrye |
imported>Wrye |
||
| Line 20: | Line 20: | ||
==Documentation== | ==Documentation== | ||
===Include a Readme=== | |||
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!" | 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. | * 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. | * 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. | * 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. | ||
===Flag Alpha/Beta Releases=== | |||
Flag an unfinished mod as alpha or beta release. Unfinished mod include those that have known bugs you weren't able to fix yet as well as mods with missing or awkwardly substituted stuff (for example a pants-icon as placeholder-icon for a new skirt model) | |||
== Packaging == | == Packaging == | ||