CruS Mod Base

Adds useful modding things (in the future), custom level support and more.

Requires the CRUELTY SQUAD MOD LOADER

Features

• Custom level support
• Button in settings that tells you what mods you have installed
• Build custom levels right from TrenchBroom with minimal Godot use
• Cheats
• Take fun little snapshots of levels

Install

1. Download the latest release
2. Extract the CruS Mod Base folder to %appdata%\Godot\app_userdata\Cruelty Squad\mods

Adding custom levels

1. Download a level
2. Extract its folder to %appdata%\Godot\app_userdata\Cruelty Squad\levels
   • This folder is created automatically if you run the game with the mod installed, or you can create it yourself

Where to find custom levels

Check out CRUS.CC for all the released maps

See this guide if you want to make your own

• Sin Space Extended by Uggo and Consumer Softproducts
• Belgha Festival by oldmankai and Just_Matt
• McMansion Estate by Oskodos and voxelectrica
• Church Schizm by Oskodos
• dust2 ported by StookyPotato
• Armed Men In A Building by ConsulCast
• Financial Ruins by Keith Mason and Asaklair
• Funko Factory by Ringo
  • Requires Ringo's Mapping Enhancements for Cruelty Squad mod
• Golf Resort by Keith Mason

Cheats

When in-game, type ceomindset and hit enter to enable the cheat prompt, which can be activated by pressing `/~ ('/@ on UK layout keyboards, for whatever reason).

NOCLIP - Enable noclip

• Shift-N to toggle noclip, Ctrl to fly downwards, Space to fly upwards, Shift-scroll to change flyspeed

ZOMBIE - Zombie mode (no longer lose health when hit)

PSYCHOPASS - Hostile enemies will no longer target and/or damage you

MAGPUMP - Infinite magazine

HOPTOIT - Infinite gunkboost jumps, whether you have them equipped or not

KITTED - Infinite arm implant uses

LIGHTSOUT - Toggle AI on/off

SOULSWAP - Toggle life/death health

FRIDAY - Toggle hostile AI going berserk

PLEROMA - Enable level debug menu

Level config JSON properties

• File paths are strings starting with user:// (Godot equivalent of %appdata%\Godot\app_userdata\Cruelty Squad\) or res:// (game files)
  • You can just write the file name if it's in its own level directory (e.g. user://levels/MyLevel/dialogue.json can be shortened to dialogue.json)

Required

• author - String
  • Level author
• version - String
  • Level version
• description - String
  • The description that appears in-game when you select a level
• objectives - String[]
  • The objectives that appear in-game when you select a level
• level_scene - File path (.tscn)
  • The actual Godot scene file containing the level

Optional

• name - String
  • Name of the level. Defaults to whatever the name of the mod's directory is
• image - File path (.png)
  • 240x240 image used for both the level icon and preview image in-game
• music - File path (.ogg)
  • Level music
• ambience - File path (.ogg)
  • If given, this music will play when not in combat
• dialogue - File path (.json containing a String[]) or String[] or whole number
  • Lines that NPCs in the level will say. If a whole number is given, the dialogue of the level corresponding to that number will be used.
  • Default: ["…"]
• reward - Number
  • Money reward for clearing the level, default 0
• fish - String[]
  • Fish that can be caught in the level. Make sure to use the fish tickers and not their actual name (i.e. write ["WOF ", "HDRA"] and not ["Wheel of Fortune", "Hydra"])
  • Defaults to ["FISH", "DEAD"] if none are specified
• ranks - { "normal", "normal_stock_s", "hell", "hell_stock_s" }
  • All values default to 0
  • normal - Number[3]
    • S, A and B rank normal thresholds in milliseconds
  • normal_stock_s - Number
    • S rank normal stock weapons threshold in milliseconds
  • hell - Number[3]
    • S, A and B rank cursed thresholds in milliseconds
  • hell_stock_s - Number
    • S rank cursed stock threshold in milliseconds

Credits

a1337spy for the next and previous page buttons

Uggo for the Sin Space Extended sample map

Consumer Softproducts for granting me express permission to distribute the game's source code in these mods for non-commercial use

https://github.com/Gianclgar/ for the GDAudioScriptImport.gd script

https://github.com/Matoking for making this pull request, which my own fork of Qodot builds off of