Skip to content

Latest commit

 

History

History
84 lines (73 loc) · 3.86 KB

README.md

File metadata and controls

84 lines (73 loc) · 3.86 KB
Raw

KAG Gather

Gather is an CTF event involving the use of this Discord bot to organise matches. Gather provides more structured, team-based gameplay as compared to regular CTF due to its inclusion of tickets (limited number of respawns per team). Gather is best enjoyed with teams of five and everyone in a single voice channel.

Features

  • Adjustable queue size
  • Automatic team allocation
  • Tickets
  • Match history log

Usage

Discord

  1. !link your KAG account to your Discord account
  2. !add to the queue
  3. Join the Gather server when the queue is filled and teams have been assigned

Gather Server

  1. !ready to add yourself to the ready list
  2. Wait for everyone to ready
  3. ???
  4. Profit!

Prerequisites

  • A KAG server (and knowledge of how to setup and host it)
  • A Discord server in which you have administrator permissions
  • GatherLite mod
  • NodeJS

Setup

Gather Server

  1. Setup the server
  2. Put GatherLite into the Mods folder
  3. Add GatherLite to a new line of mods.cfg
  4. Ensure the following settings are applied to autoconfig.cfg:
    • sv_gamemode = CTF
    • sv_canpause = 0
    • sv_tcpr = 1
    • sv_tcpr_everything = 0
    • sv_tcpr_timestamp = 0
    • Set sv_rconpassword to anything you like and keep note of it for later
    • Optional: Include a Discord invite link in sv_info (the mod points new players to an invite link in the server description)
  5. Start the server

Discord Bot

  1. Create an application and set it as a bot user
  2. Add the bot to your Discord server. I recommend using this site to do so
  3. Make a copy of example.env, name it .env, and fill in all fields
    Note: There should be no space between = and the value of each field (e.g. PREFIX=!)
  4. Move the bot's administrator role above all other Gather roles so the bot is able to manage them
  5. Type npm install to install the dependencies
  6. Run the bot by typing npm start in the base directory or by running keepalive.sh
    The console output should be similar to the following: 
    Logged into Discord as Gather
Connected to XXX.XXX.XXX.XXX:XXXXX
    You should also see a message similar to the following in #gather-general: 
    The bot has successfully established a connection with the Gather server and is ready for use
    If the bot connects but then immediately disconnects, the RCON password in .env does not match the RCON password on the server

Gather is now ready to go!

Customisation

  • Add a custom mapcycle
  • Tweak the mod properties in GatherLite/gather.cfg
  • Tweak the balance of CTF (you will need modding experience to do this)
    Some suggestions include:
    • Adjust the costs of shop items
    • Adjust the coin rewards for building, dealing damage, destroying siege, etc.
    • Doors stay open for longer to disincentivise fighting through team doors
    • Water bombs/arrows stun all players to reduce the effectiveness of water spam
    • Increase the spread of fire to reduce the effectiveness of temporary wooden structures

Acknowledgements

Thanks to the following people for helping Gather reach the stage it's currently in:

License

This project is licensed under the MIT License - see the LICENSE file for details