Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a README. #15

Merged
merged 4 commits into from
Jul 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# 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` and `git`,
- Use `rustup` to install the Rust programming language,
- If `rustup` didn't install it for you, install `build-essential` or your distro's equivalent,
- 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`.
4 changes: 2 additions & 2 deletions astro_mod_integrator/src/handlers/item_list_entries.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ use unreal_mod_manager::unreal_pak::{PakMemory, PakReader};

use crate::AstroIntegratorConfig;

#[allow(clippy::ptr_arg)]
#[allow(clippy::assigning_clones, clippy::ptr_arg)]
pub(crate) fn handle_item_list_entries(
_data: &(),
integrated_pak: &mut PakMemory,
Expand Down Expand Up @@ -104,7 +104,7 @@ pub(crate) fn handle_item_list_entries(
if array_property.name.get_content(|e| e == arr_name) {
item_types_property
.entry(entry_name.clone())
.or_insert_with(Vec::new)
.or_default()
.push((
i,
j,
Expand Down
Loading