-
Notifications
You must be signed in to change notification settings - Fork 39
Home
A mod manager for Linux.
GitHub | Nexus | Releases | Report an issue | Ko-Fi
- Install Amethyst - AppImage, Flatpak or AUR.
- Install your first mod - from a zip, the Downloads tab, or straight from Nexus.
- Deploy - move the modded files into the game, then launch it however you normally do.
| Page | What's in it |
|---|---|
| FAQ | Why Data_core exists, hardlinks vs symlinks, folder casing, which games get added, "my mod won't work". |
| Installing | Installing, updating and uninstalling Amethyst itself, plus pre-release builds. |
| Page | What's in it |
|---|---|
| Installing a mod | The four ways to install a mod, and how to remove one. |
| Mod Files Tab | Disable files, change what counts as top level, preview images and text, pack/unpack BSA/BA2. |
| Updating a Mod | Update checks, the version picker, and Quick Update. |
| Installing a collection | Nexus collections for premium and free users, updating, and recovering from a crash mid-install. |
| Creating and uploading a collection | Creating and uploading Nexus collections |
| Mods not working | Pointers on how to diagnose problematic mods |
| Profile Specific Saves | Keeping saves per profile - the Bethesda option and the custom path option. |
| Page | What's in it |
|---|---|
| Understanding Conflicts | Loose file vs BSA/BA2 conflicts, what each flag means, the Show Conflicts window. |
| Using Separators | Grouping the modlist, separator locks, custom deployment paths. |
| Profile Groups | How to group profile together |
| Root folder building | Getting files into the game's root folder instead of the mod folder. |
| Page | What's in it |
|---|---|
| Deploy and Restore | What deploy and restore actually do, best practices, runtime generated files, script extenders. |
| Case Alias Symlinks (Faster Loading) | Explains how Bethesda games can be made to load faster under Proton |
| CLI Mode | Deploy and restore from a terminal or a Steam shortcut - handy for Gaming Mode. |
| Page | What's in it |
|---|---|
| Installing VNV and TTW | Guide to installing VNV or TTW using the in app wizard |
| Page | What's in it |
|---|---|
| Using external applications | The wizard menu: Pandora, BodySlide, PGPatcher, TTW and friends. |
| Adding a custom game | Every option in the custom game editor, with worked examples. |
| The nif viewer | Using the nif viewer to preview mesh files |
| Exporting a profile | Export a profile as a file others can import, or as a short share code. |
| Page | What's in it |
|---|---|
| Keybinds | Every keyboard shortcut. |
| Launch Options | Env vars and command line arguments |
| Known Issues | A list of issues or missing features that I'm aware of. |
| Game | Notes | Game | Notes |
|---|---|---|---|
| 7 Days to Die | No Mans Sky | ||
| Abiotic Factor | Oblivion | ||
| Baldur's Gate 3 | Oblivion Remastered | ||
| Blade & Sorcery | Pacific Drive | ||
| Crash Bandicoot 4 | Palworld | ||
| Cyberpunk 2077 | Payday 2 | ||
| Daggerfall Unity | Native Linux build | Peak | |
| Darktide | Planet Zoo | ||
| Devil May Cry 5 | Pragmata | ||
| Dragon Age Origins | Pseudoregalia | ||
| Dragons Dogma 2 | Ready Or Not | ||
| DragonSword: Awakening | Red Dead Redemption 2 | ||
| Dyson Sphere Program | R.E.P.O | ||
| Enderal | Normal and SE | Resident Evil | 2, 3, 4, 7, Village, Requiem |
| Expedition 33 | Rimworld | ||
| Fallout 3 | Normal and Goty | Risk of Rain 2 | |
| Fallout 4 | Normal and VR | RuneScape: Dragonwilds | |
| Fallout 76 | Schedule 1 | ||
| Fallout New Vegas | Skyrim | Normal, SE and VR | |
| FF VII Remake Intergrade | Slay The Spire 2 | ||
| FF XII: The Zodiac Age | Slime Rancher | ||
| Gothic 1 Remake | Spyro Reignited Trilogy | ||
| Green Hell | Stalker 2 | ||
| Grounded | 1 and 2 | Stardew Valley | |
| Halo: Campaign Evolved | Starfield | ||
| Hogwarts Legacy | StarRupture | ||
| Hollow Knight: Silksong | Stellar Blade | ||
| ICARUS | Street Fighter 6 | ||
| Infection Free Zone | Subnautica | ||
| Inscryption | Subnautica 2 | ||
| Jagged Alliance 3 | Subnautica Below Zero | ||
| Kingdom Come Deliverance | 1 and 2 | Supermarket Simulator | |
| Kingdom Hearts 3 | SW: Jedi Fallen Order | ||
| Lethal Company | Tainted Grail: The Fall of Avalon | ||
| Marvel Rivals | TCG Card Shop Simulator | ||
| MechWarrior 5: Mercenaries | The First Berserker: Khazan | ||
| Mewgenics | The Last Caretaker | ||
| Monster Hunter Rise | The Sims 4 | ||
| Monster Hunter Wilds | Valheim | ||
| Monster Hunter World | Windrose | ||
| Morrowind | Normal and OpenMW | Witcher 3 | |
| Mount & Blade II: Bannerlord | X4 Foundations | ||
| My Summer Car |
Amethyst uses the Meson build system.
Build requirements: git, meson, ninja, Python 3
Runtime requirements (install via your distro or pip): PySide6, requests, py7zr, Pillow, lz4, zstandard, websocket-client, keyring, msgpack, bsdiff4
A native 7-Zip binary (7zz/7z) on your PATH is strongly recommended, extraction is much faster than the py7zr fallback.
git clone https://github.com/ChrisDKN/Amethyst-Mod-Manager.git
cd Amethyst-Mod-Manager
meson setup builddir
meson install -C builddirThen launch amethyst-mod-manager (GUI) or amethyst-mod-manager-cli.
For distro packagers: the usual meson setup builddir --prefix=/usr and DESTDIR=pkg meson install -C builddir work as expected, and meson test -C builddir validates the AppStream metainfo.
Plugin sorting uses the libloot Python module. The app runs fine without itm sorting is just disabled. To build it you need Rust (cargo) and a C toolchain:
git clone --branch 0.29.6 https://github.com/loot/libloot.git
cd libloot/python
pip install maturin
maturin build --release
pip install ../target/wheels/libloot-*.whl- Bugs and game requests: open an issue. Include as much detail as you can - for game requests, describe how modding works for that game.
Getting started
Managing mods
- Installing a mod
- Mod Files Tab
- Updating a Mod
- Installing a collection
- Creating and uploading a collection
- Mods not working
- Profile Specific Saves
Load order and conflicts
Deploying and playing
Guides
Tools and advanced
Reference