SwQolSuite: Difference between revisions

From Unofficial Stormworks Wiki
Jump to navigation Jump to search
mNo edit summary
Echoless (talk | contribs)
m Added newline to Repository
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
swQolSuite is a community made in-game XML editing tool.  
{{DISPLAYTITLE:swQolSuite}}
swQolSuite is a quality-of-life mod originally created by PieKing1215 that contains a collection of various editor improvements and tweaks, including in-game XML-editing, multithreaded asset loading, and more.  


'''IT IS TECHNICALLY BREAKING THE EULA,''' however, the Devs have implied that as long as a tool isnt used for nefarious purposes, its OK.
'''swQolSuite technically violates the Stormworks EULA''', as it injects into and modifies the running game. The developers have implied that they don't take action against tools like this, as long as they aren't used for cheating, griefing, or other malicious pruposes. That said, this isn't an official exception, use it at your own risk.


due to the release of the new EULA, the original Dev of SwQolSuite quit working on it. here is a version kept up to date by PieKing1215:
The original creator of swQolSuite stopped maintaining the tool after Stormworks' new EULA was released. The version referenced to in this page is a fork maintained by HvTcCore, which is kept relatively up to date and has more features.


'''Repository:'''
https://github.com/HvTcCore/swQolSuite


https://github.com/HvTcCore/swQolSuite?tab=readme-ov-file
== Installation (Windows) ==
swQolSuite is a DLL injection mod, it's highly likely that your antivirus will flag it. If you have issues downloading it, disable Real Time Protection in Windows Defender for the duration of the installation, and add an exclusion to the Stormworks folder. Ensure you enable Real Time Protection afterwards.


== Usage (For Windows) ==
# Go to the [https://github.com/HvTcCore/swQolSuite/releases Releases page] of the repository
to install SwQolSuite, download the most recent release by following these images
# Download the .ZIP archive for the most recent release. In this case, you can choose between the main branch, or the branch that includes SWRIPE, a more advanced property editor.[[File:Swqolsuite-github-releases.png|frameless|860x860px]]
# Extract the downloaded .ZIP file to a folder of your choice, but It's best practice to pick a permenant dedicated folder (e.g., <code>/Stormworks/swQolSuite/</code>) rather than your Downloads folder. This makes it easier to remember where it is, and less likely for it to be automatically cleaned up by Windows.


<gallery mode="packed" heights="300">
You should now have a folder containing <code>swqols.dll</code> and <code>swqols-inject.exe</code>.
File:SwQolSuite tutorial 1.png
File:SwQolSuite tutorial 2.png
</gallery>


You should now have a ZIP file of the most recent version. You can unzip this wherever you want, and run the contained EXE when the game is launched to inject the program
== Launching swQolSuite ==
swQolSuite works by injecting code into the game, so it needs to be run ''after'' Stormworks has launched.


== Automatic Launching ==
# Start Stormworks normally through Steam and wait for it to fully load.
you can make SwQolSuite automatically launch with your game in a couple easy steps.
# Run <code>swqols-inject.exe</code> from the folder where you extracted it.


first, I would recommend making a permanent folder for SwQolSuite that you will unzip future updates into, this will make it easier to update later
If it worked, swQolSuite will attach to the game and you will have a ImGUI menu in the top-left of your screen.


* Create a SwQolSuite_Launcher.bat file anywhere, I would recommend in your permanent folder you just made, or your games root folder
== Automatic Launching ==
* right click it, and click "edit in notepad"
If you don't want to manually launch swQolSuite every time you need it, you can set Steam to launch it automatically alongside the game by using a small batch script.


* paste the following code
# '''Create the launcher script'''
<syntaxhighlight lang="batch">
## Create a new text file anywhere you like (e.g., your swQolSuite folder inside of the root Stormworks folder), and name it <code>swQolSuite_launcher.bat</code>
@echo off
### If you don't see the .bat file extension when renaming, enable File name extensions in View > Show inside of File Explorer.
## Right-click the file and choose Edit (or Edit in Notepad).
## Paste the following into the file:<syntaxhighlight lang="batch">@echo off
start "" "C:\Program Files (x86)\Steam\steamapps\common\Stormworks\stormworks64.exe"
start "" "C:\Program Files (x86)\Steam\steamapps\common\Stormworks\stormworks64.exe"
start "" "PATH_TO_SwQolSuite_EXE"
timeout /t 10 /nobreak >nul
</syntaxhighlight>
start "" "PATH_TO_SwQolSuite_EXE"</syntaxhighlight>
 
## Edit the two paths:
* replace "PATH_TO_SwQolSuite_EXE" with.. the path to your SwQolSuite exe..
### Replace <code>C:\Program Files (x86)\Steam\steamapps\common\Stormworks\stormworks64.exe</code> with the actual path to your Stormworks install, '''only if''' your game isn't installed in the default Steam location.
* update the path to the game if yours is not installed in the default location
### Replace <code>PATH_TO_swQolSuite_EXE</code> with the full path to <code>swqols-inject.exe</code> from above.
* save and exit the batch file
## Save the file and close Notepad.
 
# '''Point Steam at the script'''
* go to steam, right click Stormworks, click "properties"
## In Steam, right-click Stormworks: Build and Rescue > Properties.
## In the Launch Options field, enter <code>PASTE_THE_PATH_HERE %command%</code>
## In File Explorer, right-click your <code>swQolSuite_launcher.bat</code> file and choose Copy as path.
## Back in Steam's Launch Options field, replace <code>PASTE_THE_PATH_HERE</code> with what you've just copied, keeping %command% at the end.
## Close the Properties window.
#'''Test it'''
##Launch Stormworks from Steam as usual. A command prompt window should briefly appear, then the game should start with swQolSuite already running alongside it.
== Updating ==
swQolSuite doesn't automatically update, so when the game updates, you might need to as well.


* in the "launch options" field, paste the following
# Download the newest ZIP from the [https://github.com/HvTcCore/swQolSuite/releases Releases page].
<syntaxhighlight lang="text">
# Extract it into your existing swQolSuite folder, overwriting the old files.
PASTE_THE_PATH_HERE %command%
</syntaxhighlight>


* right click on the batch file, and click "copy as path", replace "PASTE_THE_PATH_HERE" with it
You shouldn't need to make any changes to your launcher script or Steam launch options, since they point at the path, not a particular version.


Now try launching Stormworks through steam, it should open a CMD window for a moment, then launch the game with SwQolSuite already enabled
{{DEFAULTSORT:swQolSuite}}

Latest revision as of 05:50, 23 September 2026

swQolSuite is a quality-of-life mod originally created by PieKing1215 that contains a collection of various editor improvements and tweaks, including in-game XML-editing, multithreaded asset loading, and more.

swQolSuite technically violates the Stormworks EULA, as it injects into and modifies the running game. The developers have implied that they don't take action against tools like this, as long as they aren't used for cheating, griefing, or other malicious pruposes. That said, this isn't an official exception, use it at your own risk.

The original creator of swQolSuite stopped maintaining the tool after Stormworks' new EULA was released. The version referenced to in this page is a fork maintained by HvTcCore, which is kept relatively up to date and has more features.

Repository: https://github.com/HvTcCore/swQolSuite

Installation (Windows)

swQolSuite is a DLL injection mod, it's highly likely that your antivirus will flag it. If you have issues downloading it, disable Real Time Protection in Windows Defender for the duration of the installation, and add an exclusion to the Stormworks folder. Ensure you enable Real Time Protection afterwards.

  1. Go to the Releases page of the repository
  2. Download the .ZIP archive for the most recent release. In this case, you can choose between the main branch, or the branch that includes SWRIPE, a more advanced property editor.
  3. Extract the downloaded .ZIP file to a folder of your choice, but It's best practice to pick a permenant dedicated folder (e.g., /Stormworks/swQolSuite/) rather than your Downloads folder. This makes it easier to remember where it is, and less likely for it to be automatically cleaned up by Windows.

You should now have a folder containing swqols.dll and swqols-inject.exe.

Launching swQolSuite

swQolSuite works by injecting code into the game, so it needs to be run after Stormworks has launched.

  1. Start Stormworks normally through Steam and wait for it to fully load.
  2. Run swqols-inject.exe from the folder where you extracted it.

If it worked, swQolSuite will attach to the game and you will have a ImGUI menu in the top-left of your screen.

Automatic Launching

If you don't want to manually launch swQolSuite every time you need it, you can set Steam to launch it automatically alongside the game by using a small batch script.

  1. Create the launcher script
    1. Create a new text file anywhere you like (e.g., your swQolSuite folder inside of the root Stormworks folder), and name it swQolSuite_launcher.bat
      1. If you don't see the .bat file extension when renaming, enable File name extensions in View > Show inside of File Explorer.
    2. Right-click the file and choose Edit (or Edit in Notepad).
    3. Paste the following into the file:
      @echo off
      start "" "C:\Program Files (x86)\Steam\steamapps\common\Stormworks\stormworks64.exe"
      timeout /t 10 /nobreak >nul
      start "" "PATH_TO_SwQolSuite_EXE"
      
    4. Edit the two paths:
      1. Replace C:\Program Files (x86)\Steam\steamapps\common\Stormworks\stormworks64.exe with the actual path to your Stormworks install, only if your game isn't installed in the default Steam location.
      2. Replace PATH_TO_swQolSuite_EXE with the full path to swqols-inject.exe from above.
    5. Save the file and close Notepad.
  2. Point Steam at the script
    1. In Steam, right-click Stormworks: Build and Rescue > Properties.
    2. In the Launch Options field, enter PASTE_THE_PATH_HERE %command%
    3. In File Explorer, right-click your swQolSuite_launcher.bat file and choose Copy as path.
    4. Back in Steam's Launch Options field, replace PASTE_THE_PATH_HERE with what you've just copied, keeping %command% at the end.
    5. Close the Properties window.
  3. Test it
    1. Launch Stormworks from Steam as usual. A command prompt window should briefly appear, then the game should start with swQolSuite already running alongside it.

Updating

swQolSuite doesn't automatically update, so when the game updates, you might need to as well.

  1. Download the newest ZIP from the Releases page.
  2. Extract it into your existing swQolSuite folder, overwriting the old files.

You shouldn't need to make any changes to your launcher script or Steam launch options, since they point at the path, not a particular version.