# How to start modding Cruelty Squad

*Works as of the July 3, 2023 patch*

## Requirements

- [The game](https://store.steampowered.com/app/1388770/Cruelty_Squad/)
- [Godot Engine 3.x](https://godotengine.org/download/3.x/windows/)
- Use the standard version, the .NET version might not work
- [GDRE Tools](https://github.com/bruvzg/gdsdecomp/releases/)

## Instructions

Open GDRE Tools and select *Recover project...* as shown. Select the `crueltysquad.pck` file in your game folder, which is usually in `C:\Program Files (x86)\Steam\steamapps\common\Cruelty Squad`.


Once the files have been checked, extract to an empty folder of your choice.


You should get this screen once it's finished extracting.


:::spoiler Previous instructions, read if project recovery didn't work

## Updating your project if you already followed this guide previously

Make a new folder, do the game file ripping and script decompiling steps again into that folder, then copy and replace everything **except the `addons` folder** into your existing project.

## Ripping the game files

Open up Godot RE Tools and go to *PCK > Explore PCK archive…*, which will open this dialog box. You can navigate to the .pck in your game folder, or you can copy it somewhere else like I did here.


If it tells you that some files have malformed names, ignore it. Go ahead and extract it somewhere.


## Setting up Godot

Open up Godot and create a new project with the *New Project* button.


Copy over the files you ripped into your new project's folder, replacing any files that were already there.

Quit out of the project to the project list (*Project > Quit to Project List*), and load it again. This should automatically load the project's settings. You can tell if it starts up with the Cruelty Squad splash screen, goes to the *Consumerintro* scene, and looks like this when you open up the project settings (*Project > Project Settings…* in the top-left of Godot):


<br />

:::spoiler **If the settings didn't automatically load for some reason**

Once that's done, go to your project settings, go to *Run* under the *Application* section, and make sure the main scene is `res://Cutscenes/Consumerintro.tscn` like so:


Next, go to the *Input Map* tab, and if they aren't present, add the following actions:

- movement_forward
- movement_left
- movement_right
- movement_backward
- mouse_1
- movement_jump
- crouch
- reload
- zoom
- Use
- kick
- Lean_Left
- Lean_Right
- weapon1
- weapon2
- weapon3
- switch_weapon
- Tertiary_Weapon
- drop
- Suicide
- Stocks
- Vision

and click the plus next to each of them to add key bindings. When you're done, it should look something like this:


If it isn't already there, go to the *AutoLoad* tab and add the following entry:

- Path: `res://Entities/Game_Manager.tscn`
- Node Name: `Global`


and you're done with Godot setup for now.

:::

## Next steps

At this point, get the [project setup tool](https://github.com/crustyrashky/crus-project-setup-tool).

Once you've downloaded the setup tool, extract the `_SETUP_PROJECT_` folder into the project root folder like so:


Open it, run `setup_scripts.bat` and wait until it says *Script setup complete*. Go back to Godot and run the game by hitting F5 or clicking the play button in the top-right and it should work. You're done, unless you want to get the intro working.

## Getting the intro working

The scripts bundled with the setup tool already have all the script-based changes to make it work included, so all that's left is to open up `Cutscenes/Consumerintro.tscn` in Godot (assuming it isn't already open), click the *Spatial* node at the top of the *Scene* tab on the left, and set *Next Scene* in the Inspector tab on the right to `res://Cutscenes/Cutscene1.tscn`.


You can also click the *Timer* node right under it and set its *Wait Time* to 5 seconds, if you want the startup logo to last long enough to see it all like normal. I have no idea why these properties get reset when the game is ripped.

:::spoiler Doing things manually (outdated, left in the guide for posterity)
{%hackmd l3rp_mG8QzGW71BNVGyufw %}
:::

## Conclusion


After fixing whatever errors pop up, your very own Cruelty Squad project to hack away at is complete. Now that you effectively have the game's source code at your fingertips, please don't do anything stupid and/or copyright-infringing enough for the dev to consider making the process harder.

Want to try your hand at mapping? Take a look at [this guide](https://hackmd.io/@OsM6oUcXSwG3mLNvTlPMZg/SkYQwbONu).

## Notes

- Since your modding project will share the same user data folder as the actual game by default, making a backup of your saves in `%appdata%\Godot\app_userdata\Cruelty Squad` is strongly recommended before really getting into modding
- If you want to change the project's settings, delete `project.binary`, otherwise the settings will reset once you close the project

### Not errors

These don't affect the project and are mostly caused by not having the original development assets. All you can do is ignore them, or if you're adventurous and neurotic enough, compile a version of Godot that doesn't have them.

- Can't preload resource at path: ...
- Anything involving _get_modified_time
- Any error where the dot is yellow and not red (that's just a warning)
- Unable to enable addon plugin at: 'res://addons/BitmapFontCutter/plugin.cfg' parsing of config failed.

## Links

[Cruelty Squad official discord](https://discord.gg/PnEKUZp2H8)

[Developer (Consumer Softproducts) twitter](https://twitter.com/CSoftproducts)

[CRUELTY SQUAD MOD LOADER](https://github.com/crustyrashky/crus-modloader)

[My youtube channel](https://www.youtube.com/channel/UC2j_rbOpdyTMTX2jjGHvYWw)