Releases Checklist

This page aims to list all that is necessary to push a new (major) release of our mods.

While you should follow all of these sections in order, make sure to get someone working on the multimedia soon, preferably months in advance, at least for the trailer and music.

Pushing out a hotfix .esp or a bugfix .esm is somewhat simpler [instructions to be written].

Administrative

• Set a deadline for the release! That seems to be the only way to get people to make the final, laborious push.
• Determine if all release-critical interiors, quests, literature, dialogue, and assets are in and reviewed and that all game-breaking bugs are fixed. If not, direct reviewers to work on these ASAP.
• Ask players and developers to test as much of the mod as possible – preferably, leave several days to a couple of weeks for this.

Release Files

Project Master File

• Merge all section files needed for the release into the main project .esm (e.g. TR_Mainland.esm) using the merge-to-master approach.
  • Note! Make sure to first merge all claim, asset, and bugfix .esp-s dependent on .esm section files into the respective section files. Otherwise, references to section file objects will be changed and the .esp-s will not make the needed edits.
• Error Check Results should be run on the release candidate without saving the file for any errors not known to be false positives.
• Run tes3cmd clean to remove junk cells added by the Construction Set from the last stable project main file .esm.
• Run tes3cmd common on Morrowind.esm, Tribunal.esm, Bloodmoon.esm to weed out any accidental junk edits. The only results should be LTEX, LAND, CELL and DIAL.
  • DIAL: all topics, but there should be no INFO (except two in greeting 7) – that would be dirty dialogue. Check and remove any of that with tes3cmd delete --type INFO --exact-id "..." – same for any other type of dirty objects.
• Now is your last chance to fix wrong IDs! Don't forget to recompile any scripts that use these IDs (tes3cmd example).
• Modify the file's datetime, summaries and author information using Wrye Mash. Make sure to also change the version number, so that mlox and other tools can differentiate one release from the other. For Tamriel Rebuilt:
  • Modified date: 01/01/2012 19:00:00
  • Description: Main File v. 22.11 (change to new version)
  • Author: Tamriel Rebuilt Team

Optional Plugins

• Load optional plugins (e.g. TR_Factions) with the newly compiled main project .esm and Tamriel_Data.esm and save to update the masters.
• Ensure the faction changes in TR_Factions are based on the latest version of Tamriel_Data. In practice that means cleaning out the faction edits from TR_Factions and then recreating the increased reputation requirements.
• Modify the files' summaries, author, and version number. For Tamriel Rebuilt:
  • Author is always Tamriel Rebuilt Team
  • TR_Factions.esp: Faction File v. 22.11 <2 line breaks> Increases faction advancement requirements and extends Telvanni Hortator quests to mainland councilors
  • TR_Firemoth_Vanilla_Patch.esp: Firemoth Compatibility patch v. 22.11 <2 line breaks> Extends the landscape of the official Siege at Firemoth plugin as to not conflict with Tamriel Rebuilt's mainland. <2 line breaks> Load after Siege at Firemoth.esp
• Modify the files' datetime stamps. For Tamriel Rebuilt:
  • TR_Factions: 01/01/2012 19:00:01
  • TR_Firemoth_Vanilla_Patch:01/01/2012 19:00:02

Optional MGE/Lua Content

Any project specific MGE and Lua content from the PTR_Addons repository should also be included in the archive as optional content.

Archive

Compile an archive according to the BAIN format:

• Required release files in the folder 00 Core.
  • Documentation in its subfolder Docs (see the section below).
• optional plugins in other folders starting 01 [Name] and so forth.

Documentation

Several items of documentation should be updated prior to release.

Changelog

To get information for the changelog, you will have to dig through merged claims, fixed bugs, and comments listed on the relevant release file pages. Also ask on Discord if you've missed anything major.

• General notes:
  • Additions/removals of bundled plugins, along with short explanations as to why.
  • Changes to dependencies (e.g., required version of Tamriel Data).
  • Overall nature of the release (major/minor content release, bugfix, etc.).
• Main plugin file (e.g,. TR_Mainland.esm, Sky_Main.esm):
  • Amount of land cells, interior cells, NPCs, and quests added.
  • New settlements and regions added.
  • Major questlines.
  • Especially interesting miscellaneous quests.
  • New factions (e.g. vampires, ashlanders, guilds with quests).
  • Especially interesting new locations (e.g. monasteries with quests or unique dialogue).
  • New quests added to older areas.
  • Noticeable changes or removals of content from older areas, along with short explanations as to why.
  • A mention of the ballpark number of bugs fixed.
  • Other major or interesting additions and changes that you can think of.
• Other plugins (e.g., TR_Factions.esp, TR_Firemoth_Vanilla_Patch.esp) should also list any changes done.

Note: Asset changes and additions should ideally be separate and bundled with the new Tamriel_Data release.

Readme

Update at least the following items:

• Build version and date.
• URL links.
• Install instructions:
  • Needed/recommended plugins.
  • Improvements in OpenMW launcher GUI.
  • Changes in folder structure.
• Changes to recommended mods.
• Travel links from the vanilla game.
• Beginning blurb, if any, which lists the current content available in the mod.
• Statements of vision or philosophy – ensure they conform to modern consensus among the developers (e.g. whether or not the project aims to "do better than vanilla").
• Project Status or Future Updates section – update to briefly state where current development progress is.
• All places which state how long the mod has been in the work.
  • E.g. for Tamriel Rebuilt: "...undertaken by many fans over the course of Tamriel Rebuilt's twelve years in existence."
• Known bugs and issues, currently unfinished content.
• Known incompatible mods.

Credits

Credits may be bundled in the readme or be in a separate file in the download.

• Add new exterior/interior/quest developers that have passed showcases since last release.
• Add asset developers that are credited on the Tamriel Data addon Github or are listed as developers on merged assets.
• Add newly promoted reviewers under the QA section.
• Add reporters of fixed bugs under the QA section.

Post the credits on Discord and ping all developers so that they can check if they are properly credited.

Multimedia

Several items of multimedia need to be commissioned well in advance (sometimes months) of a full release.

Dominions of Dust banner by Meriyal.

Dominions of Dust portrait-format teaser banner by Meriyal. The daedric text reads "Dominions."

Release Banner

• A 4:3-format banner, similar in style to the banners for the vanilla game and expansions. Include:
  • The name of the project in smaller letters.
  • The name of the new expansion underneath it in larger letters.
  • An embossed shape underneath the text (e.g. an Almsivi triangle or an Imperial diamond).
    • For simpler designs like the triangle or diamond, an image in the theme of the new expansion is usually carved inside (e.g. Michael Kirkblade art of the Dreugh, scales from the House Hlaalu banner).
  • For Morrowind, a frame with the Daedric names of the Morrowind's houses similar to the vanilla banners should be added.
• A portrait-format banner in the same style, but with only a short Daedric text in the theme of the expansion name, is very useful in generating hype prior to release (example).

Modern Tamriel Rebuilt banners have been made either by Meriyal or Taniquetil.

Graphics for Release Pages

• A pretty text banner showing the name of the project and the new expansion.
• Section headers in the same style.
• A simple silhouette map showing the total playable area.
• A more detailed shaded gridmap cut-out showing the area added by the new expansion.

See the Tamriel Rebuilt Nexus page for good examples of these graphics, made by Meriyal.

Soundtrack

A new unique piece of music is ideal to go with the trailer. Previously, these have been made for us by ASKII (Erik Rettig) or Eric Gordon Berg.

If efforts towards this fail, take a piece from an earlier soundtrack – e.g. here for Tamriel Rebuilt.

Trailer

A trailer is critical for inducing public interest. All efforts should be made to ensure a trailer exists for a release.

It would be best if the structure of the trailer mimics that of the original TES III trailer. In any case, include the following:

• unique music,
• landscape and city birds-eye and ground-level shots,
• combat with new enemies,
• unique quest set pieces,
• new armor/weapon sets,
• quest dialogue.

When shooting footage, use MGEXE default shaders (or if an equivalent package comes out for OpenMW, use that), but no graphics-modifying mods. Morrowind Optimization Patch and the like are, of course, okay. AI upscale mods like Intelligent Textures or Morrowind Enhanced Textures may also be okay, and should be paired with HD Tamriel Data. Other mod additions need discussion beforehand.

Our previous trailers were made by DarkElfGuy.

Screenshots

Make at least 10 new screenshots of new settlements and landscapes to be used on our site gallery, release post, and Nexus page.

Use the same mod load-out (or lack thereof) as mentioned in the trailer section above.

If possible, it's best if someone with a sense for cinematics and composition takes the screenshots. Any old birds-eye shot does not cut it.

Website

Several pages on the website need to be updated every time a release happens. This can be done by developers with site editor privileges. If you wish to help with this, ask on Discord.

• Download page (here for Tamriel Rebuilt):
  • Add new Google Drive download links (project administrators have the links to official project Google Drive accounts).
  • Add new checksums.
• Release announcement on the project front page:
  • Embed the trailer.
  • Add the release banner.
  • Add direct links to the release files and checksums.
  • For at least the first two paragraphs, use evocative language describing the themes of the release; don't be overly technical and dry.
  • Add the main highlights of the new release.
  • Add the total amount of new exterior cells, interior cells, and quests added compared to the prior project release.
  • Add a couple screenshots interspersed between the text.
  • Prior to going live, post the announcement on a Project Organization forum post (for Tamriel Rebuilt) and a non-public Discord channel, and ask for feedback.
• Add the new changelog (here for Tamriel Rebuilt; since the newest release is on top, you may need to change the book page weights).
• Add a new gallery with images from the expansion.
• Update the recommended mods page.
• Update the install instructions page.
• Change values in administration section of website. All of these are in the Administration|Content|Structure section:
  • Rename 'FUTURE RELEASE' in the Version list in Taxonomy to the appropriate version number, and change the alias url for it.
  • Create a new 'FUTURE RELEASE' entry in the Version list in Taxonomy, and manually sort that at the top of the list.
  • Update Default value for 'Found in Version' Field in a Bug item in Content Types to the newly renamed version from the previous steps.
• Make sure the following Frequently Asked Questions (link for Tamriel Rebuilt) are updated:
  • changed, removed or added plugins,
  • travel links,
  • MWSE-Lua or OpenMW-Lua features,
  • compatible or recommended mods,
  • BSAs, if the number and name of BSAs changes or if OpenMW Launcher UI improves,
  • (Tamriel Rebuilt) completion FAQ,
  • (Tamriel Rebuilt) factions FAQ, if changes to TR_Factions.esp are made,
  • (Tamriel Rebuilt) quests FAQ, to update the numbers,
  • (Tamriel Rebuilt) settlement name FAQ, if settlement names are changed.
• (Tamriel Rebuilt) Push the release announcement to the main page carousel (needs a special thin banner; you can just crop a PR screenshot).
• (Tamriel Rebuilt) Make sure the silhouette map on the main page conforms to the current gridmap shape.
• (Tamriel Rebuilt) Make sure the playable area map on these pages – [1] [2] – is updated.

Public Relations

These channels are how we actually get the word out. The information below may become outdated as platforms and our presence there changes.

For all of these channels, we should have official project accounts. Developers with access to the Tamriel Rebuilt of Project Tamriel administrative channels should be able to access the credentials.

Nexus and Morrowind Modding Hall

These are the main points of entry for our players; make sure the page(s) look nice.

• Add new expansion banners.
• Replace the release map.
• Add some new gallery screenshots.
• Remove screenshots that show outdated stuff.
• Add the new changelog.
• Update the dependency versions.
• Go over the features and FAQ sections to update outdated information.

Discord

Compose a short post, including the following:

• embedded trailer,
• embedded release banner (optional, not if you only have one post to do this),
• short bullet points of release highlights,
• download link.

Post in the following servers/channels:

• Tamriel Rebuilt,
• Project Tamriel,
• Morrowind Modding Community (#mod-releases and #project-tamriel-rebuilt),
• Elder Scrolls Discord (talk with the admins on posting it on the announcements channel),
• (optional) Padomaic Isles and OAAB servers.

Youtube

• Post trailer on Youtube using the official project account prior to the release, but set it hidden.
• Add a description:
  • mod download link,
  • one-sentence short description of what the mod is,
  • one-sentence description of what the new release adds,
  • credits and links to the composer of the music,
  • credits and links to the maker of the trailer.
• Add a very short pinned top-level comment:
  • explain that this is a mod for TES III: Morrowind,
  • Include the download link.
• Un-hide trailer on Youtube once the actual release happens.

UESP

• Write a short two-paragraph advert with the release banner. Look at other UESP news posts for an idea about the length and style.
• Ask UESP staff to upload it to the front page. Previously, Dillon was the one to converse with UESP.

Reddit

Note: on most general-purpose gaming subreddits, there is a rule against self-promotion. Hence, you cannot use the official project Reddit account, nor any other personal account that is more than 50% about our projects. Instead, try to get another developer or a community member to post the links on these subreddits.

• Publish trailers or release announcement posts (prefer links to trailers) on the following subreddits:
  • r/Morrowind (use the official Tamriel Rebuilt or Project Tamriel Reddit account)
  • r/tes3mods (use the official Tamriel Rebuilt or Project Tamriel Reddit account)
  • r/PCGaming (use a personal account)
  • r/Games (use a personal account)
  • r/ElderScrolls (use a personal account)
• Add a short top-level comment to all of the above posts:
  • what the project is,
  • the highlights of the latest release,
  • the download link.

Twitter

Publish the trailer on Twitter.

Additional Resources

Old checklist by Rot containing more information that should not be needed with current workflow.