Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pieking1215/swqolsuite

Mod for Stormworks with several QoL patches
https://github.com/pieking1215/swqolsuite

dll-injection mod stormworks

Last synced: about 1 month ago
JSON representation

Mod for Stormworks with several QoL patches

Awesome Lists containing this project

README 

        
# swQolSuite

Mod for [Stormworks: Build and Rescue](https://store.steampowered.com/app/573090/Stormworks_Build_and_Rescue/) that adds some QOL settings.


Only supports 64 bit Windows version (stormworks64.exe). It might work through wine/proton/etc, but untested.






## READ THIS FIRST

swQolSuite uses low level techniques (DLL injection + ASM manipulation) to patch the game since there's no other way to do it.


Due to the nature of these methods, I won't make any guarantees about stability.


**If something goes wrong it will most likely crash your game, so please save your work often.**


Injecting or ejecting the mod are the most likely to crash, but it might also be possible when changing settings while in use (eg. changing editor settings while in editor)



**swQolSuite will likely be flagged by your Windows/antiviruses** (`Trojan:Win32/Wacatac.B!ml`) 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](https://github.com/PieKing1215/swQolSuite/wiki/Building).



swQolSuite is not a cheating/griefing tool, please do not request features that give you an advantage over other players in multiplayer.



## Download

For releases, see [Releases](../../releases).


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.


Or download the latest at https://nightly.link/PieKing1215/swQolSuite/workflows/autobuild/main


Unzip and run swqols-inject.exe to run.



## Basic Usage

Have Stormworks open and run the injector exe.


A couple menus should appear ingame:

- swQolSuite: shows version number & commit SHA, and has an "Eject" button which removes the mod.


- Tweaks: shows the settings for all of the mod's features, see below for details.


- Errors: if there were any errors loading features, they will be shown in this window (hidden if no errors).



*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.



## Game Updates

The patches are set up so they should usually continue to work after game updates unless related parts of code were touched.


If after an update any patches fail, you should just get an error in the error window and the failing tweak will be disabled until it is updated to work again.



# Features

See [Tweaks & Settings](https://github.com/PieKing1215/swQolSuite/wiki/Tweaks-&-Settings)



## Licenses



Licensed under either of



 * Apache License, Version 2.0

   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

 * MIT license

   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)



at your option.



## Contribution



Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall be

dual licensed as above, without any additional terms or conditions.



## Disclaimer

I am not personally affiliated with Stormworks: Build and Rescue or Geometa, nor has Stormworks: Build and Rescue or Geometa endorsed this product.


Stormworks: Build and Rescue and any of its content or materials are the property of their respective owners.