Expand description
§Outer Wilds Mod Manager Core Package
The core library for the Outer Wilds Mod Manager.
Core |
CLI |
GUI
The core library for the Outer Wilds Mod Manager, this package is responsible for basically everything from fetching the db to downloading mods to validating local mods to launching the game.
§Usage
cargo add owmods_core
§Analytics
In order to send analytics events you’ll need to set the ANALYTICS_API_KEY environment variable before compilation.
§Configuration
This package operates using the global manager configuration located in ~/.local/share/ow-mod-man (and similar on other OSs).
You can change these paths by passing a different path in a Some variant to Config::get and Config::default.
You can change the OWML path by simply passing a different path to OWMLConfig::get
§Building
To build this package locally clone the repo git clone https://github.com/ow-mods/ow-mod-man and run cargo build -p owmods_core
Modules§
- alerts
- Fetch database alerts and get mod warnings.
- analytics
- Send analytics events.
- config
- Work with the configuration of the app.
- constants
- Useful constants
- db
- Work with both remote and local databases.
- download
- Download and install mods and OWML.
- file
- Utilities when working with files.
- game
- Run the game and setup prerequisites on Linux.
- io
- Import and export mods from JSON arrays.
- mods
- Work with local and remote mods.
- open
- Open shortcuts and mod readmes.
- owml
- Work with the OWML config.
- progress
- Utilities for managing and parsing progress bars.
- protocol
- Utility for parsing the owmods:// protocol.
- remove
- Uninstall mods
- search
- Generalized searching
- socket
- Listen to logs from the game.
- toggle
- Enable/Disable mods.
- updates
- Check for and update mods.
- validate
- Validate the local database for common issues