mirror of
https://github.com/ow-mods/ow-mod-man.git
synced 2025-12-11 20:15:50 +01:00
README typos
This commit is contained in:
parent
1dec46e46c
commit
c0f8b899bd
@ -1,6 +1,6 @@
|
|||||||
# Outer Wilds Mod Manager
|
# Outer Wilds Mod Manager
|
||||||
|
|
||||||
> **CURRENT A WORK IN PROGRESS!!**
|
> **CURRENTLY A WORK IN PROGRESS!!**
|
||||||
|
|
||||||
This is the monorepo for the new [Outer Wilds](https://www.mobiusdigitalgames.com/outer-wilds.html) Mod Manager, completely re-implemented in Rust/Tauri.
|
This is the monorepo for the new [Outer Wilds](https://www.mobiusdigitalgames.com/outer-wilds.html) Mod Manager, completely re-implemented in Rust/Tauri.
|
||||||
|
|
||||||
@ -19,7 +19,6 @@ This is the monorepo for the new [Outer Wilds](https://www.mobiusdigitalgames.co
|
|||||||
| **Deck** | ❓ |
|
| **Deck** | ❓ |
|
||||||
| **MacOS** | 😐 |
|
| **MacOS** | 😐 |
|
||||||
|
|
||||||
|
|
||||||
## Release Profile
|
## Release Profile
|
||||||
|
|
||||||
To reduce binary sizes, some features have been enabled that will slow down release compile time, but make a significantly smaller binary.
|
To reduce binary sizes, some features have been enabled that will slow down release compile time, but make a significantly smaller binary.
|
||||||
@ -38,4 +37,4 @@ Then check each package for guide on running and contributing.
|
|||||||
|
|
||||||
**Please format your code (`cargo fmt`) and lint it (`cargo clippy --fix`)**
|
**Please format your code (`cargo fmt`) and lint it (`cargo clippy --fix`)**
|
||||||
|
|
||||||
Also make sure if you're working on platform-specific behaviour to test it on all platforms.
|
Also make sure if you're working on platform-specific behaviour to test it on all platforms.
|
||||||
|
|||||||
@ -6,7 +6,7 @@ The CLI interface for the mod manager, built using clap.
|
|||||||
|
|
||||||
This is just the output of `owmods help`, but im guessing if you're here you can't use it for some reason.
|
This is just the output of `owmods help`, but im guessing if you're here you can't use it for some reason.
|
||||||
|
|
||||||
```
|
```txt
|
||||||
A CLI Tool To Manage OWML Mods
|
A CLI Tool To Manage OWML Mods
|
||||||
|
|
||||||
Usage: owmods [OPTIONS] <COMMAND>
|
Usage: owmods [OPTIONS] <COMMAND>
|
||||||
|
|||||||
@ -1,26 +1,26 @@
|
|||||||
# owmods-core
|
# owmods-core
|
||||||
|
|
||||||
The core library for the outer wilds mod manager, this package is responsible for basically everything from fetching the db to downloading mods.
|
The core library for the Outer Wilds mod manager, this package is responsible for basically everything from fetching the db to downloading mods.
|
||||||
The other two packages in this repo act as a frontend to this package.
|
The other two packages in this repo act as frontends to this package.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Before getting started your program needs to handle two things:
|
Before getting started your program needs to handle two things:
|
||||||
|
|
||||||
1. Implementing a LoggerBackend and ProgressHandler and creating a logger
|
1. Implementing a LoggerBackend and ProgressHandler and creating a Logger
|
||||||
2. Loading the config
|
2. Loading the config
|
||||||
|
|
||||||
These will need to be passed to nearly any function in the library
|
These will need to be passed to nearly any function in the library
|
||||||
|
|
||||||
### Implementing Traits
|
### Implementing Traits
|
||||||
|
|
||||||
Implement `LoggerBackend` and `ProgressHandler`, these willl handle outputting data about what the library is doing while it's working.
|
Implement `LoggerBackend` and `ProgressHandler`, these will handle outputting data about what the library is doing while it's working.
|
||||||
|
|
||||||
Then, create a new logger `owmods_core::logging::Logger::new(Box::new(myLoggerBackend));`.
|
Then, create a new logger `owmods_core::logging::Logger::new(Box::new(myLoggerBackend));`.
|
||||||
|
|
||||||
### Loading Config
|
### Loading Config
|
||||||
|
|
||||||
Call `owmods_core::config::get_config(&logger)`;
|
Call `owmods_core::config::get_config(&logger);`
|
||||||
|
|
||||||
### Errors
|
### Errors
|
||||||
|
|
||||||
@ -35,7 +35,7 @@ log!(logger, error, "{:?}", theError);
|
|||||||
|
|
||||||
### On Linux
|
### On Linux
|
||||||
|
|
||||||
On Linux the wine_prefix config variable must be set before running `owmods_core::game:launch_game`.
|
On Linux the wine_prefix config variable must be set before running `owmods_core::game::launch_game`.
|
||||||
|
|
||||||
To do this call `owmods_core::game::setup_wine_prefix`. **Note that while although this method exists for windows builds, you should not call it (it'll just log an error but still).**
|
To do this call `owmods_core::game::setup_wine_prefix`. **Note that while although this method exists for windows builds, you should not call it (it'll just log an error but still).**
|
||||||
|
|
||||||
@ -49,7 +49,7 @@ It's recommended to only setup the prefix if the wine_prefix setting is `None`,
|
|||||||
- db.rs: Manages fetching and compiling the local and remote database
|
- db.rs: Manages fetching and compiling the local and remote database
|
||||||
- download.rs: Manages downloading and installing mods and OWML
|
- download.rs: Manages downloading and installing mods and OWML
|
||||||
- game.rs: Manages running the game and setting up a wine prefix on linux
|
- game.rs: Manages running the game and setting up a wine prefix on linux
|
||||||
- io.rs: Manages importing and exorting the list of mods
|
- io.rs: Manages importing and exporting the list of mods
|
||||||
- lib.rs: Exports stuff
|
- lib.rs: Exports stuff
|
||||||
- logging.rs: Creates traits that dependents are expected to implement for logging
|
- logging.rs: Creates traits that dependents are expected to implement for logging
|
||||||
- mods.rs: Hols the structs that represent local and remote mods and some utility functions
|
- mods.rs: Hols the structs that represent local and remote mods and some utility functions
|
||||||
|
|||||||
@ -1,10 +1,12 @@
|
|||||||
# owmods_gui
|
# owmods_gui
|
||||||
|
|
||||||
|
> **CURRENTLY A WORK IN PROGRESS!!**
|
||||||
|
|
||||||
The GUI Version Of The Manager. Created with Tauri, React, Vite, TypeScript, and Pico CSS.
|
The GUI Version Of The Manager. Created with Tauri, React, Vite, TypeScript, and Pico CSS.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Check out the [mods website](#) for instructions.
|
Check out the [mods website](https://outerwildsmods.com/mod-manager/) for instructions.
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user