Skip to content

Commit 50f5f87

Browse files
RedRanger14claude
andcommitted
docs: trim the README to what a reader actually needs
Removed the beta status line, the per-game footnotes (Palworld, Battlefront II, Helldivers 2) and their asterisk markers on the games list, and cut "What it does" down to a short, general feature list with nothing game-specific in it. The detail those footnotes carried (Frostbite compiler internals, live-service patch behaviour) still lives in docs/frosty-swbf2/ and the commit history for anyone who wants it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent cf0116d commit 50f5f87

1 file changed

Lines changed: 18 additions & 82 deletions

File tree

README.md

Lines changed: 18 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,6 @@ Browse, download, install, and enable/disable [Nexus Mods](https://www.nexusmods
1515
> third-party client. Bugs are ours, so please report them here rather than
1616
> to Nexus Mods support.
1717
18-
**Status:** 1.2 beta. Supports the games listed below; Slay the Spire 2 was
19-
the proving ground and is no longer the limit. Beta means the supported games
20-
have each been installed, modded and played on real hardware, which is not
21-
the same as everything working. Expect rough edges, and back up saves you
22-
care about.
23-
2418
## Supported games
2519

2620
Thirteen games, each one installed, modded and played on real hardware before
@@ -31,54 +25,16 @@ entry for it, but that someone finished a session with mods running.
3125
2. Elden Ring
3226
3. Fallout 4
3327
4. Fallout: New Vegas
34-
5. Helldivers 2 (*)
28+
5. Helldivers 2
3529
6. Mount & Blade II: Bannerlord
36-
7. Palworld (***)
30+
7. Palworld
3731
8. Resident Evil 4
3832
9. Skyrim Special Edition
3933
10. Slay the Spire 2
40-
11. STAR WARS Battlefront II (2017) (**)
34+
11. STAR WARS Battlefront II (2017)
4135
12. Stardew Valley
4236
13. The Witcher 3
4337

44-
(***) Palworld mods come in four different shapes and the plugin routes each
45-
to where its loader actually reads it: pak mods, UE4SS script and Blueprint
46-
mods, and PalSchema's JSON mods, which are folders of json that would sit
47-
inert anywhere else. Step 1 installs UE4SS and PalSchema together. Two
48-
100-mod collections were installed and played to get here, and both taught
49-
us something: mods that offer alternatives now ask which you want instead of
50-
installing every variant at once, and mods verified to strand you or to
51-
fight the rest of a collection are installed switched off, with the page
52-
saying which and why.
53-
54-
(**) Battlefront II mods are not files the game reads - they are compiled
55-
into a data pack, which is why no Deck plugin has supported a Frostbite game
56-
before. Step 1 in the panel downloads the compiler (40 MB, once). After that
57-
installing works like any other game, except that every install or toggle
58-
recompiles the pack, which takes a minute or two. Retextures, replacement
59-
character models and multi-part mods all work: a mod that ships as a set
60-
(base, text and weapon parts) installs whole, and one that offers
61-
alternatives asks which you want by the author's own names for them.
62-
63-
The compiler is our own build. The format Battlefront II uses was
64-
unimplemented upstream, and getting mods to render correctly took six fixes
65-
between the format and the mod pipeline, all documented in
66-
docs/frosty-swbf2/. Correctness is checked rather than hoped for: the
67-
compiler's output was compared asset by asset against the desktop Frosty
68-
Mod Manager's for the same mod, decompressed content included, and every
69-
pack is read back before the plugin offers it.
70-
71-
Plugins for the desktop Frosty Mod Manager itself - BetterSabers is the most
72-
popular - are not game mods and cannot work in Gaming Mode. They are labelled
73-
in the store rather than left to fail on install.
74-
75-
(*) Helldivers 2 is a live-service game that changes its data files with
76-
every update, which breaks most mods until their authors release new
77-
versions. The plugin flags out-of-date mods with a PRE-UPDATE badge and can
78-
filter to mods updated since the game's last patch, but a mod that installed
79-
cleanly and does nothing usually just needs its author to catch up. That is
80-
the game, not the plugin, and it is the same in every mod manager.
81-
8238
### On the roadmap
8339

8440
Groundwork exists for these and they are NOT ready. They may appear in the
@@ -107,41 +63,21 @@ hardware, so the list grows slowly and on purpose.
10763
## What it does
10864

10965
- **Finds the game you are playing** and shows its Nexus mods, with search,
110-
sort and curated rails, on a controller. Games on an SD card or a second
111-
drive are found the same as internal ones, with nothing to configure.
112-
- **Downloads and installs** into the right place for that game, whether that
113-
is a mods folder, the game's data directory, a Proton prefix, or a mod
114-
loader profile. Which one is per game and handled for you.
115-
- **Collections**, installed in order, with a report at the end naming
116-
anything skipped and why.
117-
- **FOMOD installers**, presented as a controller-friendly wizard rather than
118-
a desktop dialog.
119-
- **Load order applied automatically** where a game needs one, from the
120-
collection's own ordering. Reordering it by hand is not supported yet.
121-
- **Enable and disable** any installed mod, and reset a game to vanilla.
122-
- **A health check** that reads the game's own logs and says what is actually
123-
broken, rather than guessing.
124-
- **Updates**, checked against Nexus per mod, applied with one tap, and when
125-
an update offers versions the picker opens right there.
126-
- **Filters next to sort**: the game's own categories, recently updated, and
127-
on live-service games "since the game's last update".
128-
- **Load order for Bannerlord** is solved from the mods' own declared rules,
129-
and the launcher used is the one that honours them.
130-
- **ReShade packages install** on games configured for it, with the launch
131-
options set automatically and the risk stated plainly: ReShade injects
132-
into the game's process, which anti-cheat may treat differently from
133-
ordinary mods. The warning is on the mod page before you download.
134-
- **Endorsements and author support links**, so the people who made the mods
135-
still get credit.
136-
- **When a mod was uploaded and last updated**, on its page, because "is this
137-
thing still alive?" is usually the first question.
138-
- **Long installs say what they are doing**, with a named stage and a live
139-
percentage rather than a still bar, so a slow step cannot be mistaken for a
140-
hung one.
141-
- **Mods that cannot work here are labelled before you download them**:
142-
desktop-only tools carry a badge on the tile and an explanation on the mod
143-
page, and a mod built for a different build of the game says so on its page
144-
and in My Mods.
66+
sort and curated rails, on a controller.
67+
- **Downloads and installs mods and collections** into the right place for
68+
that game automatically, with FOMOD installers presented as a
69+
controller-friendly wizard rather than a desktop dialog.
70+
- **Applies load order automatically** where a game needs one.
71+
- **Enable, disable and reset**: switch any installed mod on or off, or put
72+
the whole game back to vanilla.
73+
- **A health check** that reads the game's own logs and says what is
74+
actually broken, rather than guessing.
75+
- **One-tap updates**, checked against Nexus per mod.
76+
- **Endorsements and author support links**, so the people who made the
77+
mods still get credit.
78+
- **Clear feedback throughout**: live progress on long installs, and mods
79+
that cannot work here say so before you download them rather than
80+
failing after.
14581

14682
Not supported yet: manual load order editing, Vortex profile import, and
14783
mods that need a Windows tool to install.

0 commit comments

Comments
 (0)