TR_Readme

Version: 

Active: 

Currently in development

Checked out: 

No

This Release File contains the TR_Readme (.txt) and the user manual Source Document (TR_Readme.odt, created with LibreOffice Writer 7.2.1.2). Upon release, the ODT is exported into a PDF User Manual (TR_Readme.pdf) and the TXT and PDF are shipped together in the Docs folder along with TR's changelog.

The Readme is an ASCII version of the User Manual, but otherwise the goal should be to mirror any change in one to the other.

Unlike previous User Manuals, the revised version has completely fixed formatting and universally uses Verdana and Courier New font instead of custom downloaded ones.

To create a User Manual from the Source Document, export it as PDF/A, bookmarks enabled, with a JPEG compression of 90% and a graphic resolution of 300 DPI. There will be a message about transparency, but that can be safely ignored.

It's advisable to update the Source Document first and the Readme later, as it's easier to paste text with formatting into a document without formatting than vice versa.

These need to be updated with each release:

  • BUILD version and date at the top of the file
  • Rev. version and date at the bottom of the file
  • Tamriel_Data version in II. i. Requirements
  • VI. PROJECT STATUS date and contents
  • Credits, both developers and permissions
    • Check the website's user list and filter by badge for exterior, interior, and quest devs. All reviewers have their names added to the QA section too.
    • Asset devs and permissions may be found here first, but check devs with no badges and recent devs with merged work in the browsers. Filter by Audio, Concept Art, and Writing for relevant credits sections. Devs who only contributed in those categories shouldn't go in the general section too.
    • Concept art is the hardest category because it has been posted all over Discord and the asset browser from non-devs.

Less common but good to check:

  • Add/remove mods under IV. ii. Known Incompatibilities
  • Make sure installation instructions are still relevant. OpenMW especially is bound to change. TR may also change its folder structure.
  • III. i. Accessing the Landmass will need updates as TR_Travels changes.
  • Update Low FPS areas under i. Known Bugs.
  • Check for broken links.

Merged Bugfixes: 

Comments

Have uploaded a modified

Rot's picture

Have uploaded a modified version of this at the nexusmods site since the link was dead, the only changes being the sentence about the MGSO patch (which has been outdated for years) and the 2 readme version info lines at the bottom (was also outdated by a year).

Uploaded here with

Rot's picture

Uploaded here with proofreading, some links updated, and some cross-updating between the TXT and ODT.

Still not up to date, and still need to sort the credits issue with this and the Data permissions file (being mainly that, besides the contradiction between the readmes, the relevant one is still doing what it has no right to do and asks people to credit TR for resources taken elsewhere). Please poke me with something sharp if I don't.

After trawling the various

Rot's picture

After trawling the various relevant old forum threads 2011 onwards, and the browser here, here are the resources included since,

 

should be introduced by something like

 

This would make the most sense in the "usage permissions" txt file in Tamriel_Data, since that's what this is about and that archive is where the assets are. If there's a problem with that for some absurd reason or other, just add in the TR readme here ASAP and figure out where to put it in the Data package later,

Last section of the readme

Rot's picture

Last section of the readme found in the TR 1709 archive, updated for the Data addon:

 

Note the last "2017-07-25" file uploaded on the left here is actually a September one but not the one in the TR 1709 archive, use the latter in the future. Not updating a new file because I'm too lazy to edit the .odt version

Added update from ThomasRuz

Rot's picture

Added update from ThomasRuz

edit: credits are updated in that file, when VI. PROJECT STATUS is updated for the release changes fix the
"Terrifying Daedric
Texafornian
Foe" in the list and copy back the "Concept Artists" from the ODT to the TXT
 

Credit for dongle's water

MinerMan60101's picture

Credit for dongle's water meshes (he didn't require credit but it's good to have nonetheless)

 

added Jun 2012, from: DGL - Water Statics https://download.fliggerty.com/download-128-556
IDs:   T_Glb_TerrWater_Circle (all) (edited)
    T_Glb_TerrWater_Curve (all) (edited)
    T_Glb_TerrWater_Rect (all) (edited)
    T_Glb_TerrWater_Sqr (all) (edited)

Added all new successful

Why's picture

Added all new successful showcases since last update, updated some details pertaining to the latest maintenance release. The .odt file wasn't updated (and won't be included in the maintenance release) but we should consider bringing it back, it's fancy.

Some things as a TO DO, just

Sultan of Rum's picture

Some things as a TO DO, just since I won't be getting to this for a while:

  • Amend a sentence in the OpenMW install instructions: To follow this step, do the same as above but move/extract TR_Mainland.esm to a 'Tamriel Rebuilt' folder in whichever directory you like.
  • Ranyon-ruhn spelled wrong
  • Add Zephyr to website credits
  • Add to Special Thanks credits:
    • Ender (for starting the project)
    • Atrayonis (for reviving it)
    • The Early TR Devs Whose Names Are Lost to History

Added the above, plus some

Dillonn241's picture

Added the above, plus some more links, the MO2 notes from Sultan's instructions, and other clarifications.

Also, to summarize what I did

Dillonn241's picture

Also, to summarize what I did earlier since I forgot to post:

I completely overhauled both the TXT and ODT files. The ODT file is brand new with formatting that is easy to edit and fonts that exist for everyone. It is also a lot more readable.

There are now instructions for OpenMW, thanks to Sultan of Rum's asset that was prematurely merged. Various other enhancements are in too like a synopsis and link to our Recommended Mods page. The credits are fully up to date to the point that I could make them without going through individual asset pages hunting down concept artists.

A couple old TR big names

Sultan of Rum's picture

A couple old TR big names that aren't on the document:

  • Ash under Website management (created TR's first website).
  • Moorkh under special thanks, organization, or something-or-other (early admin/organizer. Created TR's first old claims map that was used up to 2016 at least.)