Skip to content

Commit

Permalink
Add README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
Esper89 committed May 6, 2024
1 parent 6c33ca3 commit e33a22f
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Astroneer Modloader

A modloader for Astroneer, rewritten in Rust.

## Installation

### Windows

Download the modloader (`astro_modloader.exe`) from the [releases
page](https://github.com/AstroTechies/astro_modloader/releases/latest), below the changelog.

### Linux

Pre-built binaries are not yet dsitributed for Linux. To build the modloader yourself on Linux:

- Use your distribution's package manager to install `rustup`, `git`, and `build-essential`,
- Use `rustup` to install the Rust programming language,
- Use `cargo` to install `cargo-about`,
- Use `git` to clone the modloader's repository,
- Then run the following commands in the root of the repository:

```
export USE_PRECOMPILED_CPP_LOADER=1
export USE_PREBUILT_ASSETS=1
cargo build --release
```

The last command may take a while to run. Once it's done, the executable (`astro_modloader`) will be
in `target/release`.

0 comments on commit e33a22f

Please sign in to comment.