go-modmanagers

module

v0.2.0 Latest Latest Go to latest Published: Oct 30, 2026 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Rethunk-Tech/go-modmanagers

Links

Open Source Insights

README ¶

go-modmanagers

Read-only readers for the files other mod managers keep their profiles in: Vortex, Mod Organizer 2, Stardrop, r2modman and Gale. Module github.com/Rethunk-Tech/go-modmanagers, one package per manager.

Each reader returns the manager's own records in the manager's own terms (names, version text, enabled flags, folders, Nexus ids) and never writes, locks or resolves them into another program's model. A package imports only its own format's dependencies.

Quick start

go get github.com/Rethunk-Tech/go-modmanagers

A worked example and the contracts: HUMANS.md.

Features

vortex: profiles, mods and staging folder from state.v2, read from a private copy.
mo2: instance folders, [Settings] paths, modlist.txt and meta.ini.
stardrop: profile JSON and the mods folder from Settings.json.
r2modman: .r2z exports (read and write) and profile codes read under go-archive's admission rules, profile folders, data folders per OS.
gale: the profiles table read-only, and sync codes from an id, a copied link or a gale:// deep link.

Documentation

Doc	Audience
HUMANS.md	Running and using the package
AGENTS.md	Internals, invariants, and why
CONTRIBUTING.md	Process — commits, tests, docs
SECURITY.md	Vulnerability disclosure
CHANGELOG.md	Release notes

License

Directories ¶

Path	Synopsis
gale Package gale reads Gale's profile database (data.sqlite3) and its profile sync codes.	Package gale reads Gale's profile database (data.sqlite3) and its profile sync codes.
internal
managerbase Package managerbase names the per-OS folder another mod manager keeps its data under.	Package managerbase names the per-OS folder another mod manager keeps its data under.
nexusurl Package nexusurl extracts the Nexus Mods mod id from a mod-page URL.	Package nexusurl extracts the Nexus Mods mod id from a mod-page URL.
testwrite Package testwrite writes test fixtures.	Package testwrite writes test fixtures.
mo2 Package mo2 reads Mod Organizer 2's instance folders: ModOrganizer.ini, profiles/<p>/modlist.txt and mods/<m>/meta.ini.	Package mo2 reads Mod Organizer 2's instance folders: ModOrganizer.ini, profiles/<p>/modlist.txt and mods/<m>/meta.ini.
r2modman Package r2modman reads r2modman's profile exports (.r2z files and share codes), its profile folders, and Thunderstore's profile-code API.	Package r2modman reads r2modman's profile exports (.r2z files and share codes), its profile folders, and Thunderstore's profile-code API.
stardrop Package stardrop reads Stardrop's profile files and settings.	Package stardrop reads Stardrop's profile files and settings.
vortex Package vortex reads Vortex's persisted state, the LevelDB database at <data>/state.v2.	Package vortex reads Vortex's persisted state, the LevelDB database at <data>/state.v2.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL