Skip to content
This repository has been archived by the owner on Dec 4, 2024. It is now read-only.

Commit

Permalink
Rename project
Browse files Browse the repository at this point in the history
  • Loading branch information
PieKing1215 committed Aug 17, 2024
1 parent c7a5a02 commit 32cb9c0
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 20 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/autobuild.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
- name: Upload Artifact
uses: actions/upload-artifact@v2
with:
name: "swMod-${{ steps.short-sha.outputs.sha }}"
name: "swQolSuite-${{ steps.short-sha.outputs.sha }}"
path: |
target/x86_64-pc-windows-msvc/release/swmod-inject.exe
target/x86_64-pc-windows-msvc/release/swmod.dll
target/x86_64-pc-windows-msvc/release/swqols-inject.exe
target/x86_64-pc-windows-msvc/release/swqols.dll
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "swmod"
name = "swqols"
version = "0.1.0"
repository = "https://github.com/PieKing1215/swMod"
repository = "https://github.com/PieKing1215/swQolSuite"
authors = ["PieKing1215"]
license = "MIT OR Apache-2.0"
readme = "README.md"
Expand All @@ -12,7 +12,7 @@ build = "src/build.rs"
crate-type = ["cdylib"]

[[bin]]
name = "swmod-inject"
name = "swqols-inject"
path = "src/main.rs"

[profile.dev]
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# swMod
# swQolSuite
Mod for [Stormworks: Build and Rescue](https://store.steampowered.com/app/573090/Stormworks_Build_and_Rescue/) that adds some QOL settings.<br>
Only supports 64 bit Windows version (stormworks64.exe). It might work through wine/proton, but untested.

Expand All @@ -9,23 +9,23 @@ The mod uses low level techniques (mainly ASM injection) to patch the game since
Due to the nature of these methods, I won't make any guarantees about stability.<br>
If something goes wrong it will most likely crash your game, so please save your work often (especially before injecting or ejecting the mod)<br>

swMod may be flagged by antiviruses as a side effect of how it works. The way swMod injects into the game is similar to how some viruses hook other processes, and some antiviruses will detect this.
Obviously I will say this repo (PieKing1215/swMod) and official builds do not actually contain malware to my knowledge, but if you want to be sure, look over the code and build from source.
swQolSuite may be flagged by antiviruses as a side effect of how it works. The way swQolSuite injects into the game is similar to how some viruses hook other processes, and some antiviruses will detect this.
Obviously I will say this repo (PieKing1215/swQolSuite) and official builds do not actually contain malware to my knowledge, but if you want to be sure, look over the code and build from source.

## Download
For "stable" releases (there are none right now), see [Releases](../../releases).<br>
For dev builds: sign in to GitHub, go [here](https://github.com/PieKing1215/swMod/actions/workflows/autobuild.yml?query=branch%3Amain+is%3Asuccess), click the latest one, scroll down to "Artifacts" and download it.<br>
Or download the latest at https://nightly.link/PieKing1215/swMod/workflows/autobuild/main<br>
Unzip and run swmod-inject.exe to run.
For dev builds: sign in to GitHub, go [here](https://github.com/PieKing1215/swQolSuite/actions/workflows/autobuild.yml?query=branch%3Amain+is%3Asuccess), click the latest one, scroll down to "Artifacts" and download it.<br>
Or download the latest at https://nightly.link/PieKing1215/swQolSuite/workflows/autobuild/main<br>
Unzip and run swqols-inject.exe to run.

## Basic Usage
Have Stormworks open and run the injector exe.<br>
A couple menus should appear ingame:
- SWMod: shows version number & commit SHA, and has an "Eject" button which removes the mod.<br>
- swQolSuite: shows version number & commit SHA, and has an "Eject" button which removes the mod.<br>
- Tweaks: shows the settings for all of the mod's features, see below for details.<br>
- Errors: if there were any errors loading features, they will be shown in this window (hidden if no errors).<br>

*Note: swMod does not modify any Stormworks files on disk, so if you close & reopen the game you have to re-run the injector exe*
*Note: swQolSuite does not modify any Stormworks files on disk, so if you close & reopen the game you have to re-run the injector exe*

You can press the grave/backtick/tilde key [`` `~ ``] to toggle the visibility of the menus.

Expand Down
4 changes: 2 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ struct MainHud {
impl MainHud {
fn new() -> Self {
let mut this = Self {
version_string: format!("SWMod v{}{}", env!("CARGO_PKG_VERSION"), option_env!("SHA").map_or_else(|| "".to_string(), |sha| format!(" ({sha})"))),
version_string: format!("swQolSuite v{}{}", env!("CARGO_PKG_VERSION"), option_env!("SHA").map_or_else(|| "".to_string(), |sha| format!(" ({sha})"))),
show: true,
tweaks: vec![],
errors: vec![],
Expand Down Expand Up @@ -157,7 +157,7 @@ impl ImguiRenderLoop for MainHud {
// .build(|| {});
// bg_color.end();

ui.window("SWMod")
ui.window("swQolSuite")
.no_nav()
.always_auto_resize(true)
.resizable(false)
Expand Down
6 changes: 3 additions & 3 deletions src/main.rs
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
use hudhook::inject::Process;

fn main() {
println!("SWMod Injector");
println!("swQolSuite Injector");

// basically if running using cargo, look in the right target/ folder for it
// otherwise if there's a swmod.dll in the working directory, use it.
// otherwise if there's a swqols.dll in the working directory, use it.
let mut cur_exe = std::env::current_exe().unwrap();
cur_exe.push("..");
cur_exe.push("swmod.dll");
cur_exe.push("swqols.dll");

let dll_path = cur_exe.canonicalize().unwrap();

Expand Down

0 comments on commit 32cb9c0

Please sign in to comment.