Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 2.1 KB

README.md

File metadata and controls

41 lines (26 loc) · 2.1 KB
Raw

Outer Wilds Mod Manager Core Package

OWMM Logo
The core library for the Outer Wilds Mod Manager.
Core | CLI | GUI

crates.io Documentation GPL-3 licensed CI RS Release

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