Optional. List of required mods other than Morrowind.esm. If anything other than the official expansions are required, give the details in Installation.
You may want to cut this section out if your readme is very short. Also, you can make the contents deeper by setting CONTENTS to 2.
• Overview
• Versions
• Syntax
This is where you talk about what your mod is/does. This should be fairly short (1-3 paragraphs). If you need more space, add more sections between Installation and Versions.
Optional. It's now generally assumed that players know how to install mods. So this section is primarily useful for unusual install instructions.
Version notes go here.
• Fixed global thermonuclear destruction bug. My bad.
• Yay! Finally got it out the door!
Mash's autoconversion syntax is described here. Delete this and all other italicisized instructions before distributing your readme.
To trigger Wrye Mash's autoconversion...
• Choose the txt version of the file in Mash's Doc Browser.
• First line of txt file must look like = Title ====#. Note in particular, the = at the start and the single # character at the end!
• View the document in the Doc Browser. If Mash sees that the html is older than the text file, it will do the conversion. Note that this means that you can edit the text file in an external text editor and still get autoconversion.
Copy this template to Morrowind\Data Files\Docs\My Readme Template.txt and modify as desired. That will become your default template.
The default styles can be replaced by specifying css file in a CSS tag. Note that:
• Css file must be on a line by itself.
• Css file is not linked to, but is instead included on compilation.
• Css must not contain any html markup tags (not even comments).
• Directory specification is not allowed.
• Css file must be present either in same directory as source document or in the Morrowind\Data Files\Docs directory. If it's present in both, then the version in the current directory will be used.
• If no css file is specified, then a default, sand colored style set will be used.
• You can supply your own css files or one of your own. If you use your own, please give a it unique name so that it won't overwrite css files by other modders. Included css files are:
• wtxt_sand.css (same as default style)
• wtxt_teal.css
• A good place to put the CSS tag is at the end of the document.
Level of heading is determined by number of leading '='s. Trailing equal signs are ignored.
• Bullets1
• Bullets 2
• Bullets 3
• Bullets 4
+ Alternate bullet char
o Alternate bullet char
Invisibile bullet char
• Italic
• Bold
• BoldItalic
• External Link: http://wrye.ufrealms.net or Wrye Musings
• Internal Link: Reuse and Credits or Reuse and Credits.
• All section headers can be linked to by compressing the text of the header together (i.e., by stripping out all non alphabetical characters).
• If you use the second form the link is automatically generated from the text of the link.
• Html tags work fine
• code tag has special formatting
• pre tag is useful for code
begin widgetScript short counter end
These will form one line in the compiled html.
+ This will form one continuous bullet item.
Blank lines can be used as spacers:
Optional. Licenses are particularly useful for keeping mods alive after the original author(s) has left the scene and/or the original download server has gone down. The default license below is fairly generous. You can find other licenses at Wrye Modding Licenses 1.0 or you may wish to make your own. You can skip a license altogether, but this may result in your mod becoming unavailable eventually if you can't be contacted.
• You are free to redistribute this work in unmodified form.
• You are free to modify and re-distribute this work, so long as you: 1) give the author(s) credit proportional to their contribution to the final work, 2) distribute the final work under the same terms, and 3) make artistic resources included with the final work available under the same terms as below.
• Artistic resources (meshes, textures, sounds, etc.) included with this work may be included in unmodified form with modified versions of this work, so long as their authors are given credit proportional to their contribution to the final work. Note that artistic resources may not be modified, or extracted from this work, unless permission is given elsewhere.
While the license above allows modification and redistribution, I'd prefer to keep it under my control for now. So, please try to contact me before modifying or redistributing it.
Optional. If the mod has resources, and they are under a different license, note that here.
List who did what here. E.g...
• Bethesda, for creating a great game!
Contact info. Email address, website, preferred forums, etc.