Skip to content

TheCubPlays/Team-Mod-Stick-Fight-

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 

Repository files navigation

Made with C# GitHub downloads License: LGPL v3

image

About This Mod

Ever wanted to play team-modes, like 2v2, with your friends in Stick Fight? Until now, we had to act like it's a 2v2 by trying not to hit our teammate; But no more! Now, as long as both you and your friends have this mod installed, you can experience REAL 2v2 stick fight!

Features

  • Teams - There's currently 2 teams, your team & the enemy team. By default everyone's in the enemy team until added to yours.

  • Shared Wins - Team members share wins (Configurable). There's 2 win counters, one for each team, your win counter's side matches your in-game spawn side. So if you spawn as Yellow or Red, your win counter will be displayed on the left.

  • Shared Colors - Team members share colors (Configurable). By default, your team's members are blue while the enemies are red (Configurable).

  • FriendlyFire Disabled - You can't hurt your team's members. However, they can hurt you unless they've also added you to their team. (It was made this way to prevent abuse of the mod for cheating purposes).

  • Configuration - You can configure all of the mod's features via its config file OR even in-game by executing certain commands.

  • Commands - Check below for more info regarding those.

Commands

All commands are case insensitive (So "/prefix" = "/pReFiX")

Regular Commands

  • /team list: Lists the members of your team.
  • /team add <PlayerColor>: Adds a player to your team using their spawn color (Yellow/Red/Blue/Green).
  • /team remove <PlayerColor>: Removes a player from your team using their spawn color (Yellow/Red/Blue/Green).
  • /team reset: Removes everyone from your team.
  • /scouter: Lists all online players along with their colors. It's useful for /team so that you know which player is which color since all team members share the same color and it can be hard to distinguish.

Configuration Commands

  • /prefix: Shows the prefix used for commands (By default '/').
  • /prefix <Prefix>: Configure the prefix used for commands (Must be a character)
  • /teamWinsToggle: Shows the current option for teamWinsToggle (True/False).
  • /teamWinsToggle <True/False>: When true, team member' wins will be merged to one (Visually, not actually).
  • /useTeamColor: Shows the current option for useTeamColor (True/False).
  • /useTeamColor <True/False>: When true, you & your team's members will share your team's custom color (If useColors is also set to true). When false, you'll have the game's default colors.
  • /useEnemyColor: Shows the current option for useEnemyColor (True/False).
  • /useEnemyColor <True/False>: When true, enemy team members will share their team's custom color (If useColors is also set to true). When false, they'll have the game's default colors.
  • /useColors: Shows the current option for useColors (True/False).
  • /useColors <True/False>: When true, all team members will share their team's custom color (If the corresponding useTeamColor/useEnemyColor options are also true). When false, they'll have the game's default colors (Regardless of the other 2 options).
  • /teamColor: Shows the hex color code of your team's color.
  • /teamColor <HexColorCode>: Configure your team's custom color (Must use a hex color code with format like #FF0000 or #FF0000FF)
  • /enemyColor: Shows the hex color code of the enemy team's color.
  • /enemyColor <HexColorCode>: Configure the enemy team's custom color (Must use a hex color code with format like #FF0000 or #FF0000FF)
  • /reset config: Resets all configuration settings to default values.
  • /reset prefix: Resets the prefix used for commands to default value.
  • /reset teamWinsToggle: Resets the teamWinsToggle option to default value.
  • /reset useTeamColor: Resets the useTeamColor option to default value.
  • /reset useEnemyColor: Resets the useEnemyColor option to default value.
  • /reset useColors: Resets the useColors option to default value.
  • /reset teamColor: Resets the teamColor option to default value.
  • /reset enemyColor: Resets the enemyColor option to default value.

QOL Compatibility Commands (Must have QOL Mod installed)

  • Added /useQolColors: Shows the current option for useQolColors (True/False).
  • Added /useQolColors [true/false]: When true, the QOL Mod's color functionality will completely replace the Team Mod's functionality. This means that all team color configuration options are ignored and they will not affect the game. By default it's false.

Notes

  • Your team's win counter won't necessarily have the same colour as your stickman, it has the team's colour. This means that if useColors is false (which means custom colors are disabled), your team's win counter will still have the team's colour regardless of you having default colors.
  • If the last players standing are of the same team, the round won't end. That's mainly because if that was a thing, the mod could be used as a cheat client.
  • There's no limit to the amount of teammates you can have. It could be a 4v0, 3v1, 2v2, 2v1 and 1v1.
  • Grenade Launcher & Spike Ball will damage your teammates. That's because they can damage you in the vanilla game, so it'd be weird if they can't damage your teammates as well.
  • (If you have the QOL Mod installed) Regardless of whether /useQolColors is set to true or false, the game's default colors will match QOL Mod's default colors. For example: If enemy colors are disabled, instead of using the game's default spawn colors (which is what would normally happen if you didn't have the QOL Mod installed), the colors that will be used for the enemy team are QOL Mod's default colors (Which implies you can configure them in monky.plugins.QOL.cfg and set them to whatever color you'd like!)

How To Use

In order for the mod to work properly, your team's members must have also added you to their team otherwise they'll be able to attack you and you'll be unable to. So, say you get your 3 friends in your lobby to play. Say you're A and your friends are B, C & D. Type /scouter to see which player corresponds to which color. If you wanna team up with C and their color is red, you'd type /team add red. Then, if you're yellow, C will also have to type /team add yellow. Now, congratulations, you and C are officially a team. B & D will have to do the same thing with each other. If they do that, you'll now have a functioning 2v2 lobby. Now, start the fight! :)

image

Installation Guide

  1. Download BepInEx.
  2. Go to your steam games, right click stick fight and go to Manage > Browse Local Files. The StickFightTheGame folder should open.
  3. Extract the zip file you downloaded, a folder will be created. Drag all of the newly created folder's contents to the StickFightTheGame folder. (BepInEx, changelog.txt, winhttp.dll etc.)
  4. Now start the game and exit once it loads. Now BepInEx should have generated the necessary files & folders.
  5. Download the latest version of the team mod (https://github.com/TheCubPlays/Team-Mod-Stick-Fight-/releases/tag/v1.2.2).
  6. Now go back to step 3's folder (StickFightTheGame folder) and there should be a BepInEx folder now.
  7. Go to BepInEx > Plugins.
  8. In this place, put the .dll file from the zip file. Either by manually dragging it there or extracting the zip file.
  9. You're ready, start the game and enjoy!

Config File

To access the configuration file, go to your steam games then right click stick fight and click Managed > Browse Local Files. Now, click BepInEx > config. There should be a file named cub.plugins.TMOD.cfg. There, you can change the mod's configuration settings (Just like you'd do with the commands mentioned above). Any modifications of this file are only applied when you start the game, so you can't modify it while in-game. Here's an example of a setting to configure:

## When 'true' your team's members will share the same custom color (TeamColor). When 'false' your team members will have the default colors of the game. (Yellow/Red/Blue/Green)
# Setting type: Boolean
# Default value: true
useTeamColor = true

If you wanted to disable team colors, you'd need to turn useTeamColor = true to useTeamColor = false. Then save the file and run the game.

Don't change the default values, the /reset commands use them to reset your settings.

Known Issues

  • Glue gun can affect your teammates, it won't damage them but it'll still get them stuck.
  • Ice gun won't damage or slow down your teammates, however it will still give them the ice particle making it look like it'll slow them down even though it won't.
  • Thrusters will still hurt your teammates with fire.
  • Sometimes, the custom colors can have weird bugs. Not sure what causes that yet, the bug itself is very inconsistent. It has a chance to occur when you change the player colors in-game. However I don't think this will happen often. When it happens, you have to rejoin the lobby.
  • If you block your teammate's bullet, it'll damage them if it hits them.
  • The command auto-complete doesn't work with parameters yet.
  • (If you have the QOL Mod installed) Every version of the QOL Mod up to v1.18.0 has a certain bug. After a certain arrow sequence when using the chatbox, your message will be sent when you press "escape" even when you don't want it to. The Team Mod alone doesn't have this bug but it will occur if you use any versions of the QOL Mod before v1.18.2. I believe the bug was fixed in v1.18.2, but I'm not sure if that release is available for people or not.

Credits & License Notice

Monky's source code was very helpful in the making of this mod, particularly regarding custom colors, chat commands, and overall fundamentals for modding this game.
Parts of this code are adapted from their amazing QOL Mod and are used under the GNU Lesser General Public License v3.0.

This project as a whole is licensed under the LGPL v3.0. See the LICENSE file for details.

About

A mod that allows you to create teams in Stick Fight: The Game!

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages