Come Join my Discord Kat's Paradise
Requirements
- Python 3.1 or greater
- Pip 2.1 or greater
- Discord.py 2.0 or greater
- Please visit: https://github.com/Rapptz/discord.py to install discord.py development version!
- Cube Coders AMP License
- AMP User for the Bot
- See AMP -> Configuration -> User Management
Getting Started
Installation Methods
Manual Instructions
- Open your command line: run
sudo apt-get install -y python3 pip && git clone https://github.com/Rapptz/discord.py && cd discord.py && python3 -m pip install -U .[voice]
- Create an AMP user for the Bot with
Super Admins
role. - Follow the instructions in
tokenstemplate.py
file -> tokenstemplate.py - From Command Line run script
start.py
followed by Discord Guild ID (eg.../Discord Bot/start.py 602285328320954378
)- Run the bot, it will finish installing the rest of the requirements.
- That's it for setup!
-
Optional: Setting NON-Discord Adminstrator ranks to have bot permissions, use
/bot setup rank_name
-
Optional: Setting NON-Discord Adminstrator ranks to have bot permissions, use
- See Interacting with the Bot~
AMP Instance Instructions
- Create an AMP user for the Bot with
Super Admins
role. - Create a new instance of GatekeeperV2 in a container. (The container option can be found under
Configuration -> New Instance Defaults
) - Configure the settings in the GatekeeperV2 Instance under the
Configuration -> Bot Settings
, clickUpdate
, then start the bot. - See Interacting with the Bot~
Interacting with the BotInteracting with the Bot
Channel ID and Channel Name are interchangable in commands
-
Setting your AMP Console Channels
- Use
/server console channel channel_id
and the bot will begin sending AMP Console messages to that channel.- TIP: You can also send AMP Console commands through that Discord Channel to the Dedicated Server.
- Use
-
Setting your AMP Chat Channels
- Use
/server chat channel channel_id
and the bot will begin sending AMP Chat messages to that channel.- TIP: You can also send Chat messages through that Discord Channel to the Dedicated Server.
- Use
-
Setting your Whitelist Channel/Settings
- Use
/bot whitelist channel set channel_id/channel_name
-
Optional: Using the auto-whitelist feature, simply use the command
/bot whitelist auto whitelist true
- The Bot has a default wait time of 5 minutes. (eg.
/bot whitelist waittime 5
) TIP: You can set this value toNone
or0
.- If the message was parsed successful they are added to the whitelist waitlist, after the timer is up they are whitelisted!.
- The Bot has a default wait time of 5 minutes. (eg.
-
Optional: Using the auto-whitelist feature, simply use the command
- Use
Setting up a NON-Adminstrator Role for the Bot
- TIP - Use this if you want NON-Discord Admins to have the ability to interact with the bot*
- Use
/bot setup role_id
and the bot will add that role as the minimum required role to interact with the bot.- It does honor the role heirarchy set via
Discord -> Server Settings -> Roles
.
- It does honor the role heirarchy set via
Setting your AMP Console Channels
- Use
/server console channel channel_id
and the bot will begin sending AMP Console messages to that channel.- TIP: You can also send AMP Console commands through that Discord Channel to the Dedicated Server.
Setting your AMP Chat Channels
- Use
/server chat channel channel_id
and the bot will begin sending AMP Chat messages to that channel.- TIP: You can also send Chat messages through that Discord Channel to the Dedicated Server.
Setting your Whitelist Channel/Settings
- Use
/bot whitelist channel set channel_id/channel_name
-
Optional: Using the auto-whitelist feature, simply use the command
/bot whitelist auto whitelist true
- The Bot has a default wait time of 5 minutes. (eg.
/bot whitelist waittime 5
) TIP: You can set this value toNone
or0
. - If the message was parsed successful they are added to the whitelist waitlist, after the timer is up they are whitelisted!.
- The Bot has a default wait time of 5 minutes. (eg.
-
Optional: Using the auto-whitelist feature, simply use the command
Bot ( eg. /bot settings
)
-
Settings -
Settings - Lists all Bot Settings
-
Setup -
Setup - Sets the Discord Role for Staff
-
ping -
ping - Pong!
-
cog loader - Loads a specific Cog (you must provide the directory name too)cog loader - Loads a specific Cog (you must provide the directory name too)
-
cog unloader - Unloads a specific Cog (by name)cog unloader - Unloads a specific Cog (by name)
-
stop -
stop - Stops the Bot
-
restart -
restart - Restarts the Bot
-
status -
status - Checks for AMP version/setup, DB version/setup and Displays Bot version information
-
sync - Syncs Gatekeeper commands to the current guild
Whitelist (eg.
/bot whitelist channel
)- Whitelist auto - Allows the bot to automatically Whitelist a Users request
- Whitelist channel - Sets the Whitelist channel for the bot to listen too
- Whitelist waittime - Sets the Whitelist wait time after message is received
- Whitelist done_emoji - Set an Emoji for to be applied to finished whitelist requests
- Whitelist pending_emoji - Set an Emoji to be applied to pending/waiting whitelist request
- sync - Syncs Gatekeeper commands to the current guild
-
Whitelist (eg.
/bot whitelist channel
)- Whitelist auto - Allows the bot to automatically Whitelist a Users request
- Whitelist channel - Sets the Whitelist channel for the bot to listen too
- Whitelist waittime - Sets the Whitelist wait time after message is received
- Whitelist done_emoji - Set an Emoji for to be applied to finished whitelist requests
- Whitelist pending_emoji - Set an Emoji to be applied to pending/waiting whitelist request
Server (eg. /server list
)
-
list -
list - Lists all available servers
-
start -
start - Starts the specified dedicated server
-
stop -
stop - Stops the specified dedicated server
-
restart -
restart - restarts the specified dedicated server
-
kill -
kill - kills the specified dedicated server
-
console msg - sends a message through the console for the specified dedicated serverconsole msg - sends a message through the console for the specified dedicated server
-
backup -
backup - creates a backup of the dedicated server
-
status -
status - displays a embedded message of the dedicated server with buttons for start, stop, kill and restart. (see #showcase)
-
users list - displays a list of connected users to the dedicated serverusers list - displays a list of connected users to the dedicated server
-
display name - sets the display name of the dedicated server in the DB (purely for display purposes)display name - sets the display name of the dedicated server in the DB (purely for display purposes)
-
description -
description - sets the description of the dedicated server in the DB (purely for display purposes)
-
IP-
IP- sets the IP of the dedicated server in the DB (purely for display purposes)
-
role - sets the role of the dedicated server in the DB
Donator (eg.
/server donator true
)- true - Sets Donator Only Flag for the dedicated server to True
- false - Sets the Donator Only flag for the dedicated server to False
Console (eg.
/server console on
)- on - Turns the console on for the dedicated server (default: on)
- off - Turns off the console for the dedicated server
- channel - Sets the discord channel for the dedicated server to output too
- filter - Enable or Disable console filtering for the dedicated server
Chat (eg.
/server chat channel
)- channel - Sets the discord channel for the dedicated server to output its chat messages
Whitelist (eg.
/server whitelist true
)- true - Sets the whitelist flag to true for the dedicated server
- false - Sets the whitelist flag to false for the dedicated server
- add - Adds the IGN to the dedicated server whitelist
- remove - Removes the IGN from the dedicated server whitelist
- role - sets the role of the dedicated server in the DB
-
Donator (eg.
/server donator true
)- true - Sets Donator Only Flag for the dedicated server to True
- false - Sets the Donator Only flag for the dedicated server to False
-
Console (eg.
/server console on
)- on - Turns the console on for the dedicated server (default: on)
- off - Turns off the console for the dedicated server
- channel - Sets the discord channel for the dedicated server to output too
- filter - Enable or Disable console filtering for the dedicated server
-
Chat (eg.
/server chat channel
)- channel - Sets the discord channel for the dedicated server to output its chat messages
-
Whitelist (eg.
/server whitelist true
)- true - Sets the whitelist flag to true for the dedicated server
- false - Sets the whitelist flag to false for the dedicated server
- add - Adds the IGN to the dedicated server whitelist
- remove - Removes the IGN from the dedicated server whitelist