QOL-Mod

A mod that offers quality-of-life improvements and additions to Stick Fight: The Game.
This is accomplished through a GUI menu but alternative chat commands are listed below.
To open the menu, use the default keybind: LeftShift + F1

A previous message system allows you to use the ↑ & ↓ keys to easily return to your previous messages.
There is a maximum of 20 messages stored before they start being overwritten.

This mod is a plugin for BepInEx which is required to load it. Everything is patched at runtime.

Installation

To install the mod, watch the video below, or follow the written steps:

Download BepInEx.
Extract the newly downloaded zip into the StickFightTheGame folder.
Drag all contents from the folder into the StickFightTheGame folder (winhttp.dll, doorstop_config.ini, the BepInEx folder etc.).
Launch the game and then exit (BepInEx will have generated new files and folders).
Download the latest version of the QOL mod from the Releases section.
Put the mod zip into the newly generated folder located at BepInEx/plugins and extract it to a folder named QOL-MOD for BepInEx to load.
Start the game, join a lobby, and enjoy!

Installation Tutorial Video:

2022-04-02.21-46-36.mp4

Caveats

The following are some general things to take note of:

Both the /private & /public commands require you to be the host in order to function.
The /rich command only enables rich text for you, a.k.a client-side only.
The auto-translation feature uses the Google Translate API and has a rate-limit of 100 requests per hour.
A custom player color only shows for you, a.k.a client-side only.

QOL Menu

This menu is the primary way to use and enable/disable features.
It can be opened with the keybind: LeftShift + F1
An image below shows a visual overview:

Alternative chat commands are listed directly below.

Chat Commands

Command	Description
Usage:	`/<command_name> [<additional parameter>]`
/adv	Outputs whatever you set it to in the config.
/fov	Set the FOV for the game.
/gg	Enables automatic sending of "gg" upon death of mod user.
/help	Opens up the Steam overlay and takes you to this page.
/hp `[<player_color>]`	Outputs the percent based health of the target color to chat. Leave as `/hp` to always get your own.
/id `[<player_color>]`	Copies the Steam ID of the target player to clipboard.
/invite	Generates a "join game" link and copies it to clipboard.
/lobhp	Outputs the health set for the whole lobby.
/lobregen	Outputs whether or not regen is enabled for the lobby.
/lowercase	Enables/disables lowercase mode, which has your chat messages always sent in lowercase. Useful for those who keep pressing the caps-lock key.
/nuky	Lets you talk like Nuky. Splits up any message you send and outputs it word by word.
/mute `[<player_color>]`	The targeted player's messages wont appear, making them "muted" for you (client-side only. A mute only lasts for the lobby you're currently in).
/ping `[<player_color>]`	Outpus the ping for the targeted player.
/private	Privates the current lobby (must be host).
/public	Opens the current lobby to the public (must be host).
/rainbow	Enables/disables rainbow mode. Dynamically shifts your player color through the color spectrum (the shifting speed of the colors is changeable in the config).
/rich	Enables rich text for chat (client-side only).
/shrug `[<message>]`	Appends ¯\_☹_/¯ to the end of the typed message (changeable in config).
/stat `[<player_color> <stat_type>]`	Gets the targeted stat of the targeted player. Open the stat menu to see a list of different stat names.
/suicide	Kills the user.
/translate	Enables auto-translation for messages from others to English.
/uncensor	Disables chat censorship.
/uwu	uwuifies any message you send.
/ver	Outputs the mod version string.
/winnerhp	Outputs the winner's hp at the end of every round.
/winstreak	Enables winstreak mode.

Stat Menu

The stat menu provides an easy way to view the statistics of certain player actions that the game tracks. By default it can be opened via the keybind LeftShift + F2, but also can be accessed through the QOL menu. The stats that are shown should not be taken as having absolute accuracy.

Using The Config

A configuration file named monky.plugins.QOL.cfg can be found under BepInEx\config.
Please note that you must run the mod at least once for it to be generated.
You can currently use it to set certain features to be enabled on startup.
Example:

## Enable rich text for chat on startup?
# Setting type: Boolean
# Default value: false
RichTextInChat = true

Changing RichTextInChat = false to RichTextInChat = true will enable it on startup without the need for doing /rich to enable it.

To change your player color to a custom value, please look in the config and replace the default value of FFFFFFFF to a HEX color.
An example is the color neon pink, which the HEX value is: FF10F0
Please do not include a # character at the front of your HEX value.

Another important option to mention for the config is the ability to specify an API key for Google Translate.
In doing so, this will allow you to bypass the rate-limit that comes normally with /translate.
You are responsible for creating the key, and any potential charges accrued.
Instructions & documentation for all of that can be found here.

Simply delete the config file to have a new one generated with default settings.
Updating the mod does not require you to delete the config file.

Mn0ky/QOL-Mod