docs(website): a Mods page: installing mods, turning them off, the load order and checking the log #1210
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1210
Loading…
Reference in a new issue
No description provided.
Delete branch "HumanBean/Longshot:docs/website-mods-page"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Type: docs · Risk: low · Tested on: not built here (docs only) · Needs: CI's website build and check
Why
The website has no page about mods. A player who wants to install one has to find the README's Mods section on
Forgejo, which is written as a reference, or
docs/mods.md, which is the loader's contract for authors. Neither sayswhere the launcher keeps the game folder, how to turn a mod off, or how to tell from the log whether a mod loaded.
What changed
A new player guide,
docs/using-mods.md, published at/mods/and listed under Get started after Transfer a save.It covers what works on
maintoday (RomFS file mods) and nothing that is still in a pull request.docs/using-mods.md: before you start (back up saves, stop the game), installing (the launcher's Openfolder, one
modsfolder per version, the<name>/romfslayout, emulator layouts), turning a mod off (_or-), which mod wins a shared file, resource size tables for mods that make files bigger, themods:log lines fromhost/mods.cand what each means, and what doesn't work (exefspatches, no mod manager). It ends with links tothe README's Mods section and
docs/mods.mdfor authors, andHOS_MODS.website/src/content-pages.tsaddsmods;website/astro.config.tsadds it to the sidebar.docs/updates-and-saves.md's Mods section and the README's Mods section link to the new guide.Measurements
Nothing to measure: documentation only.
Flags and settings
None.
Testing
Tested: the log lines and the folder rules read against
host/mods.c(hos_mods_init,find_mods,hos_mods_romfs) and the README's Mods section; the links' targets (saves.md#where-longshot-keeps-them,README.md#mods,mods.md) exist. No game-branding terms fromGAME_BRANDINGin the new page.Not tested: no tests or website build were run on this PC; CI runs
tests/run_all.pyand the website's build andnpm run check.Must be tested:
npm run checkpass with the new page, expecting/mods/in the sidebar and its linksresolving (CI's website workflow).
Risks
What could break: the website build, if the new page trips a check.
Turning it off: revert the commit.
Compatibility: Nothing changes.
Checklist
Everyone
type(scope): description) of the status line's type.main.python -I -B tests/run_all.pypasses (any failure that also fails onmainis named).third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.🤖 Generated with Claude Code
Possibly related, for context:
WIP: docs(website): a Mods page: installing mods, turning them off, the load order and checking the logto docs(website): a Mods page: installing mods, turning them off, the load order and checking the logWebsite preview: https://pr-1210-longshot-website.hckr-5e0.workers.dev/mods/
Uploaded by hand from a PC (
wrangler versions upload --preview-alias pr-1210, afternpm run buildwith Node 24.14) at5923a776cc; production is unchanged.npm run checkwas not run here: CI's website job runs it.