Difference between revisions of "Category:About Modding Etiquette"
Category:About Modding Etiquette (edit)
Revision as of 15:50, 28 September 2006
, 15:50, 28 September 2006→Things to know when making a Mod: fix list
imported>Dev akm |
imported>Dev akm (→Things to know when making a Mod: fix list) |
||
| Line 17: | Line 17: | ||
*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. | ||
*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) | *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) | ||
| Line 23: | Line 23: | ||
*Make your release OMOD-ready by including OMOD conversion data for [[Oblivion Mod Manager]]. This avoids the need to release a separate OMOD version while still giving users an easier way to create their own OMOD. In an OMOD-ready archive, all the "omod conversion data" is pregenerated and included as a separate directory, including readme, install scripts (if any), screenshot, etc. This way, when the user goes to create an OMOD from the extracted download, OBMM finds that directory and asks if you want to import the conversion data. | *Make your release OMOD-ready by including OMOD conversion data for [[Oblivion Mod Manager]]. This avoids the need to release a separate OMOD version while still giving users an easier way to create their own OMOD. In an OMOD-ready archive, all the "omod conversion data" is pregenerated and included as a separate directory, including readme, install scripts (if any), screenshot, etc. This way, when the user goes to create an OMOD from the extracted download, OBMM finds that directory and asks if you want to import the conversion data. | ||
You should probably include a very brief OMOD_or_Manual_Install.txt file explaining the steps. Feel free to use any of the files included in this [http://devnull.devakm.googlepages.com/BTSRNormalMapsReduced.7z small mod package] as a guideline (I'll post a separate modder's resource version as soon as possible). | **You should probably include a very brief OMOD_or_Manual_Install.txt file explaining the steps. Feel free to use any of the files included in this [http://devnull.devakm.googlepages.com/BTSRNormalMapsReduced.7z small mod package] as a guideline (I'll post a separate modder's resource version as soon as possible). | ||
The best thing about this approach is that it works just as well for users who like OMODs and those who don't (the only difference is the one extra directory in the archive). | **The best thing about this approach is that it works just as well for users who like OMODs and those who don't (the only difference is the one extra directory in the archive). | ||
[[Category:Getting Started]] | [[Category:Getting Started]] | ||