Skip to content
This repository has been archived by the owner on Sep 14, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yannickgloster committed Nov 9, 2020
1 parent 6d4ca26 commit 0e4cc9d
Showing 1 changed file with 23 additions and 9 deletions.
32 changes: 23 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,14 @@ Do you have a csgo server and want to organize PUGs with your friends in discord
- Queue Based PUG w/ Ready Up
- Multiple Servers
- Random Captains
- Selected Captains
- Player Veto
- Map Veto
- Selected Map
- Auto Voice Channel Creation for Teams
- Channel Deletion After Game
- Score Updates in Text Channel
- Auto Server Configuration
- [Get5 Features](https://github.com/splewis/get5#get5)
- Match Statistics Collection ***COMING SOON***
- [Dathost](https://dathost.net/) Support ***COMING SOON***
Expand All @@ -28,20 +31,31 @@ Do you have a csgo server and want to organize PUGs with your friends in discord
## Commands
#### User Commands
- `.pug`: Starts a pug with the members of a voice channel. There must be 10 members in the voice channel and each member must have used the `.link` command.
- You can add the option arguments `random` or `map_name` to the command to start the pug with random teams or a predefined map.
- You can also at a user to make them team captain.
- `.pug` has a series of optional arguments. You can use as many of the optional arguments together as you'd like:
- `.pug @user`: sets the user as a team captain
- `.pug <map_name>`: sets the map
- `.pug random`: randomizes the teams
- Examples:
- `.pug @retsol` - sets retsol as team captain
- `.pug random` - a pug with a map veto but random teams
- `.pug de_dust2` - a pug on de_dust2 with a player veto
- `.pug random de_dust2` - a pug with random teams on de_dust2
- `.pug de_dust2 random` - a pug with random teams on de_dust2
- `.pug @retsol @lexes`: will set retsol and lexes as team captains
- `.pug random`: a pug with a map veto but random teams
- `.pug de_dust2`: a pug on de_dust2 with a player veto
- `.pug random de_dust2`: a pug with random teams on de_dust2
- `.pug de_dust2 random`: a pug with random teams on de_dust2
- `.link <Steam Community URL or Steam ID>`: Connects a users steam account to the bot. Must have done before running a `.pug`.
- `.connect`: Shows the server connect message.
- `.matches`: Shows the live matches and their scores.
- `.connect ?<server id>`: Shows the server connect message. Optional server id if there are more than 1 servers.
- `.matches`: Shows the live matches and their scores.
- `.about`: Get's the bot's version number

#### Admin Commands
- `.setup_match_size`: Set's the number of players in a match. The default value is 10. It also changes the queue size if enabled.
- `.connect_dm <True | False>`: If set to true, instead of posting the ip to your csgo server in the general message, it sends the user a DM.
- `.add_spectator @user`: Adds the tagged users as spectators in the server.
- `.remove_spectator @user`: Removes the tagged users as spectators in the server.
- `.setup_queue <True | False>`: Enables or disables the queue.
- `.set_queue_captain @user`: Adds the tagged users as captains in the queue. Once they are a captain, they won't be a captain again unless you specify it with this command
- `.empty_queue`: Kicks all voice members from the queue.
- `.force_restart_queue`: Restarts the queue task.
- `.force_end ?<server id>`: force ends a match on a server. Defaults to the first server if you don't provide a server ID.
- `.map_pool <list of map names>`: Updates the map pool to the list of maps provided. **Untested.**
- *Example:* `.map_pool de_dust2 de_mirage de_vertigo`: Sets the map pool to Dust2, Mirage, and Vertigo.
- `.RCON_message <message>`: Sends the RCON command, `say <message` to the CSGO Server to test if RCON works.
Expand Down

0 comments on commit 0e4cc9d

Please sign in to comment.