Giter Club home page Giter Club logo

morrowind's Introduction

LOOT

CI Documentation Status Translation status

Introduction

LOOT is a plugin load order optimiser for:

  • Starfield
  • The Elder Scrolls III: Morrowind
  • The Elder Scrolls IV: Oblivion
  • The Elder Scrolls V: Skyrim
  • The Elder Scrolls V: Skyrim Special Edition (and Anniversary Edition)
  • The Elder Scrolls V: Skyrim VR
  • Fallout 3
  • Fallout: New Vegas
  • Fallout 4
  • Fallout 4 VR
  • Nehrim: At Fate's Edge
  • Enderal: Forgotten Stories
  • Enderal: Forgotten Stories (Special Edition)

LOOT can automatically calculate a load order that satisfies all plugin dependencies and maximises each plugin's impact on your game. It can also detect many issues, and provides a large number of plugin-specific usage notes, warnings and Bash Tag suggestions for Wrye Bash.

While LOOT can correctly handle the vast majority of plugins without help, some plugins need additional metadata to be sorted correctly. LOOT has a masterlist of metadata for each supported game, and you can add more to customise LOOT's behaviour.

LOOT helps make using mods easier, and you should still possess a working knowledge of mod load ordering. See Introduction To Load Orders for an overview.

Downloads

Releases are hosted on GitHub. Linux users should install LOOT from Flathub.

Snapshot builds are available as artifacts from GitHub Actions runs, though they are only kept for 90 days and can only be downloaded when logged into a GitHub account. To mitigate these restrictions, snapshot build artifacts include a GPG signature that can be verified using the public key hosted here, which means it's possible to re-upload the artifacts elsewhere and still prove their authenticity.

The snapshot build artifacts are named like so:

loot_<last tag>-<revisions since tag>-g<short revision ID>_<branch>-<platform>.<file extension>

Snapshot builds are also provided as single-file Flatpak bundles, which can be installed like so:

flatpak --user install ~/Downloads/loot.flatpak

You may also want to install the Adwaita theme:

flatpak install flathub org.kde.KStyle.Adwaita//6.7

Building LOOT

Windows

Refer to .github/workflows/release.yml for the build process.

The GitHub Actions workflow assumes that CMake, curl, gettext, Git, Inno Setup 6, Python, Visual Studio 2019 and 7-zip are already installed.

vslavik's precompiled Gettext binaries are probably the easiest way to get an up-to-date version of Gettext on Windows.

Linux

Refer to .github/workflows/ci.yml's flatpak job for the build process.

Building the Flatpak is relatively self-contained and should only need the following installed:

  • git
  • flatpak
  • flatpak-builder
  • python, pip and venv

Your Linux distribution may package Python, pip and venv separately.

Not all LOOT's features have been implemented for Linux builds. Issues labelled linux on LOOT's issue tracker cover such missing features where they can be implemented.

CMake Variables

LOOT uses the following CMake variables to set build parameters:

Parameter Values Default Description
LIBLOOT_URL A URL A GitHub release archive URL The URL to get the libloot release archive from. By default, this is the URL of a libloot release archive hosted on GitHub. Specifying this is useful if you want to link to a libloot that was built and packaged locally.
LOOT_BUILD_TESTS ON, OFF ON Whether or not to build LOOT's tests.
LOOT_RUN_CLANG_TIDY ON, OFF OFF Whether or not to run clang-tidy during build. Has no effect when using CMake's MSVC generator.
MINIZIP_NG_URL A URL A release archive URL The URL to get a source archive from.
OGDF_URL A URL A release archive URL The URL to get a source archive from.
VALVE_FILE_VDF_URL A URL A GitHub commit archive URL The URL to get a source archive from.
ZLIB_URL A URL A release archive URL The URL to get a source archive from.

The URL parameters can be used to supply a local path if the archive has already been downloaded (e.g. for offline builds).

You may also need to set BOOST_ROOT if CMake cannot find Boost, and Qt6_ROOT (e.g. to C:/Qt/6.7.2/msvc2019_64) if CMake cannot find Qt.

Building The Documentation

The documentation is built using Sphinx. Install Python and make sure it's accessible from your PATH, then run:

py -m venv .venv
.venv\Scripts\activate
pip install -r docs/requirements.txt
sphinx-build -b html docs build/docs/html

If running on Linux, replace .venv\Scripts\activate with .venv/bin/activate.

Alternatively, you can use Docker to avoid changing your development environment, by running docker run -it --rm -v ${PWD}/docs:/docs/docs:ro -v ${PWD}/resources:/docs/resources:ro -v ${PWD}/build:/docs/build sphinxdoc/sphinx:7.1.2 bash to obtain a shell that you can use to run the two commands above.

Packaging Releases

Packaging scripts are provided for creating an installer on Windows and compressed archives on Windows and Linux.

Run the scripts/installer.iss Inno Setup script to build an installer executable in the build folder. If the unofficial Korean, Swedish and Simplified Chinese Inno Setup translation files are installed alongside the official translation files, then the installer script will also offer those language options. If they are not found, the installer will be built without them.

The archive packaging script requires Git, and on Windows it also requires 7-Zip, while on Linux it requires tar and xz. It can be run using python scripts/archive.py, and creates an archive for LOOT in the build folder. The archives are named as described in the Downloads section above.

The archive packaging script calls windeployqt.exe when run on Windows: it must be accessible from your PATH.

morrowind's People

Contributors

dacoolx avatar illusiveman196 avatar macsplody avatar ortham avatar pstyl3 avatar sibir-ine avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

morrowind's Issues

Add mods to incompatible list with Patch for Purists

The following ESPs/ESMs are incompatible with Patch for Purists (any of its modules could be checked against, but I'd do Patch for Purists - Base Patch.esm since it makes the most sense)

This info is from the description: https://www.nexusmods.com/morrowind/mods/45096?tab=description

Other morrowind patches (Unofficial Morrowind Patch (UMP), Morrowind Patch Project (MPP)):

  • Morrowind Patch v1.2.2.esm

  • Morrowind Patch v1.6.3.esm

  • Morrowind Patch v1.6.4.esm

  • Morrowind Patch v1.6.5-BETA.esm

  • Morrowind Patch 1.6.5 Beta (BTB Edit).esm

  • Morrowind Patch v1.6.5d_beta.esm

  • Morrowind Patch v1.6.6_beta.esm

  • gr_ScriptImprovements.esp

  • gr_ScriptImprovements.esm

From Morrowind rebirth:

  • Morrowind Rebirth [Main].ESP

I'd assume you can just check against that one, but just in case, here's the rest:

  • Dramatic Vivec [For Rebirth].esp
  • Holamayan Monastery Replacer [For Rebirth].esp
  • Illegal Dwemer Trading [For Rebirth].esp
  • Julan Ashlander Companion 2.02 [For Rebirth].esp
  • Solstheim TotSP [For Rebirth].esp
  • Uvirith's Legacy_3.53 [For Rebirth].esp
  • Morrowind Rebirth - Birthsigns [Addon].ESP
  • Morrowind Rebirth - Game Settings [Addon].ESP
  • Morrowind Rebirth - Mercenaries [Addon].ESP
  • Morrowind Rebirth - Races [Addon].esm
  • Morrowind Rebirth - Skills [Addon].ESP
  • Morrowind Patch Project 1.6.5 [For Rebirth].esm

Add List of Incompatible Mods for Graphic Herbalism - MWSE Patches

While it doesn't (on its own) have an ESP, we can save people a bit of work by checking for it using its main patch:

They can't have both of the following, just one:

  • correctUV Ore Replacer_fixed.esp
  • correctUV Ore Replacer_respawning.esp

And the following ESPs would be incompatible with either if detected:

  • Graphic Herbalism Extra (Correct UV).esp
  • correctUV Ore Replacer 1.0.esp
  • Graphic Herbalism.esp
  • Graphic Herbalism Extra.esp
  • Graphic Herbalism TR.ESP
  • Graphic Herbalism TR Extra.ESP

Add Incompatibilities for Improved Argonians

Improved Argonians.esp is incompatible with the following:

  • Wey_New_Argonians.ESP
  • Slof's Civilised Beasts.esp
  • Slof's Better Beasts b.esp
  • Slof's Better Beasts a.esp
  • Slof's BB neck fix.esp

Area of Effect Arrows plugins and patches

Following is copied from Discord:

Morrowind Masterlist, Area of Effect Arrows mod. There are actually at least 4 of them:
Official Bethesda plugin
2 Unofficially patched versions, merged and separate
Area Effect Arrows Integrated further improves and expands AEA content
BCoM's patch-replacer in folder 54 Area of effect Arrows, named Area Effect Arrows

Currently LOOT checks only plugin name and complains about BCoM patch which is supposed to be for every AEA version currently up for download. How to improve masterlist? CRC check for relevant version or something else?

Add Rules for Official Mods released by Bethesda

Original files can be found here official plugins released by Bethesda

List of official plugins:
adamantiumarmor.esp
AreaEffectArrows.esp
bcsounds.esp
master_index.esp
EBQ_Artifact.esp
entertainers.esp
LeFemmArmor.esp
Siege at Firemoth.esp

Plugins are patched or replaced in:


  • Sorting Rules
  • Already Included in Messages.
  • Compatibility.
  • Deactivate plugins, Merged Versions Require Assets.

loot

it doesn,t work. wont install

Add Beautiful Cities of Morrowind and patches

Beautiful Cities of Morrowind

Sources:
BCoM BAIN installation details
Mlox rules
Included readme files


Core files

Beautiful cities of Morrowind.ESP
BOM_pathgrid_reset.esp
Interior exterior flag reset.ESP

  • Check MLOX rules for core files, and test against LOOT sorting. (Optional, as that could take some time)

Optional files

SOP_RichPlaza_IziStyle.ESP Haalu Council Hall Plaza - Izy Style

  • Incompatible with Brevur of Balmora - Finally Some Good Statue Mod.ESP.
  • Marking them as incompatible once is enough.

SOP_Canal_01.ESP Riverside - Simple Cluttering

  • Appears as part of load order for some other mods.

SOP_Canal_02.ESP Riverside - Stone Dock

BOM_OpenMW_plazas.ESP Weather Mechanics for OpenMW

BCOM_Suran Expansion.ESP Suran dock expansion & clutter addon

BOM_White_Suran.ESP White Suran

BOM_Stavs_MGO.ESP Stav's Mages Guilds

BOM - Taller Lighthouse.ESP Taller Lighthouse

BOM_Sadrith_Mora_dock_expanded.ESP Expanded Sadrith Mora Dock

  • No mentions in Mlox rules file

Patches

Patch for Purists.esm Patch for Purists

  • Patch included in installer BOM_PfP_patch.ESP.

Rise of House Telvanni.esm Rise of House Telvanni

  • Patch included in installer BOM_ROHT_Patch.ESP.

Replacement Plugins

abotBoats.esp Boats

  • Requires Resources from original mod.
  • Patch BOM_abot_boats.esp included in installer.

Animated_Morrowind - merged.esp RandomPal's random mods and patches

  • Requires Resources from original mod.

Brevur of Balmora - Finally Some Good Statue Mod.ESP Brevur of Balmora - Finally Some Good Statue Mod

  • Requires Resources from original mod.
  • Incompatible with Izy Style Standalone SOP_RichPlaza_IziStyle.ESP.

Foyada Mamaea Overhaul.ESP Foyada Mamaea Overhaul

  • Requires Resources from original mod, if using version with CRC 2978B483.
  • Use version for Red Mountain Reborn if that's installed. CRC E68E1B2C

GITD_Telvanni_Dormers.ESP Glow in the Dahrk

  • Requires Resources from original mod.

Improved Inns Expanded.esp Improved Inns Expanded

  • Could be added as a patch included message, but we could add a new message for replacement plugins.
  • No resources required.

Improved Inns Expanded - Entertainers.ESP Improved Inns Expanded

  • Could be added as a patch included message, but we could add a new message for replacement plugins.
  • No resources required.

MQE_MainQuestEnhancers.esp Main Quest Enhancers

  • Could be added as a patch included message, but we could add a new message for replacement plugins.
  • No resources required.

RedMountainReborn.esp Red Mountain Reborn

  • Requires Resources from original mod.

ROHT_2_0_8.ESP Rise of House Telvanni - 2.0

Siege at Firemoth.esp Unofficial Morrowind Official Plugins Patched - UMOPP 3.1.0

  • Requires Resources from original mod.

To be continued with adding patches for mods and mods themselves.
This also may be treated as a "transcribe "fresh" Mlox rules into LOOT" as almost 1/2 or 3/4 of them are for BCOM and related mods and/or patches.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.