Gatekeeper

Welcome to the efforts of countless hours of learning and failed attempts at writing code that culminated into this project known as Gatekeeper! Originally this started out as a bot to bring CubeCoders AMP to Discord with support for only Minecraft, but has evolved into this encompasing project of providing support for any type of server AMP can run along with providing as many of AMPs core features inside of Discord.

Need Support or have questions? Please visit my Discord and post in the respective channels. Come Join my Discord - Neko Neko Cafe

Features

User friendly with very basic setup required by the User. Gatekeeperv2 can manage its own permissions inside of AMP.
- Can Support more complex Permission setups. See the Permissions Guide for more information.
Ability to control AMP Servers with Discord slash commands and Text input.
- Interaction with AMP Server Consoles and Server Chat via Discord Text Channels.
Uses a SQL Database to store Users and Server information.
Full support inside of AMP via AMP Template with constant updates.
- See AMP Instance Instructions
Cross platform support; Windows or Linux.
- See Running Gatekeeperv2 as a Service
Support for your own Cogs/AMP Dedicated Server.
- See cog_template.py and amp_template.py for brief examples.
Uses Autocomplete features to help complete commands and help navigation.
- Full Support for Discord Channels, Discord Roles and AMP Servers.
Supports custom Banner images for displaying AMP Server specific information.
Supports Regex Patterns for custom filtering of your AMP Console to Discord Channel output
- This also works on Events such as Disconnect, Deaths and Kills.

Requirements

Python 3.8 or greater Python 3.12 -> Help
- See Setting up Python
Pip 22.1 or greater
Cube Coders AMP License
- https://cubecoders.com/AMP
Discord Bot Account
- See Creating a Discord Bot Account

Setting up Python

Installing Python on Linux

A version of Python is installed on most Linux systems by default. It might not however include all the required packages.

Note - For Debian/Ubuntu and similar systems, make sure you have the pip and venv packages installed.

For example, to install latest Python version available in the system repository, install:

`python3 python3-pip python3-venv`

Or for a specific version:

`python3.11 python3-pip python3.11-venv`

For RHEL or similar systems, consult your system documentation. An example might be:

`python39 python3-devel`

Installing Python on Windows

Installers can be downloaded from here.

Run the installer as Administrator, and select “Customize installation”.
- Make sure you select the option to install pip, and (under Advanced Options) the options to install Python for all users on the system and add it to the system’s environment variables.
- Note - This will mean Python is installed in Program Files and is essential to ensuring it can be used by AMP.

Installing Python 3.12

Follow instructions listed above for your respective operating system.

Open the requirements.txt and update numpy==1.25.1 -> numpy and yarl==1.9.2 -> yarl to no longer have version requirements.
- Simply save the text file after the edit and restart.
- Note - Any future updates may require this change again.

Creating a Discord Bot Account

Please visit Creating a Bot Account
- Use this Scope and Permissions -> Permissions
- Enable the Intents Gatekeeper Needs -> Intents

Installation Methods

Manual Instructions

Create an AMP user for the Bot with Super Admins role, must be done on the Global AMP Home Screen GUI.
- Usually this is the URL ending in 8080 when connecting to AMP. (eg. http://X.X.X.X:8080)
- Remember the Log-in details for your newly created AMP user.
Follow the instructions in tokenstemplate.py file -> tokenstemplate.py
- Rename tokenstemplate.py to tokens.py before you start.
From Command Line run script start.py (eg. ../Discord Bot/start.py)
- Run the bot, it will finish installing the rest of the requirements.
See Interacting with the Bot~

AMP Instance Instructions

Create an AMP user for the Bot with Super Admins role, must be done on the Global AMP Home Screen GUI.
- Usually this is the URL ending in 8080 when connecting to AMP. (eg. http://X.X.X.X:8080)
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, click Update, then start the bot.
See Interacting with the Bot~

Interacting with the Bot

First Time Startup

After Gatekeeper has connected to your server, please run the command $bot utils sync inside the Discord server you invited to bot to.
- This should populate all of its available commands to your guild.
See Commands for a full list of all Bot Commands and how to use them.

Updating the Command Tree

When commands are added or removed it is highly suggested that you reset your command tree and re-sync
- See Bot Commands /bot utils sync for details on how to reset your local command tree.
- TIP: Gatekeeper will reset and auto sync on updates that require a re-structure of the commands.

Setting up a NON-Discord Adminstrator Role for the Bot

Use /bot moderator (role) and the bot will add that role as the minimum required role to interact with the bot.
- TIP: Use this if you want NON-Discord Admins to have the ability to interact with the bot
- It does honor the role heirarchy set via Discord -> Server Settings -> Roles.
- Want more control? See Setting up Custom Permissions.

Setting your AMP Console Channels

Use /server console channel (channel) 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.
- ATTENTION: Interacting with the console this way requires a special permission node server.console.interact or having Discord Admin and or Bot Moderator Role.

Setting your AMP Chat Channels

Use /server chat channel (channel) 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 AMP Event Channels

User /server event channel (channel) and the bot will begin sending AMP Event messages to that channel.
- Events are when a player Joins or Leaves and Achievements.

Setting your Whitelist Channel and Auto Whitelist Settings

Use /whitelist request_channel (channel) to set a channel for the bot to send Whitelist Request Approvals to.
- ATTENTION: By default Auto-Whitelist is turned off, meaning someone with Discord Admin or Bot Moderator role or higher must approve the request.
Use /whitelist auto true to allow the bot to handle whitelist requests.
- ATTENTION: Gatekeeper has a default wait time of 5 minutes, after the wait time is up requests are auto-approved.
- TIP: You can enable Donators to bypass the wait time after setting the /bot donator role.
Use /whitelist wait_time (time) to adjust the Bot's wait time after a whitelist request.
- TIP: You can set this value to 0 to allow the bot to instantly approve the users whitelist request..

Setting up your Server Banner Displays

First, set all your servers settings/information. See Server Commands
- Adjust your settings on via sub commands such as Host, Description, DisplayName, Prefix and Whitelist to name a few.
- TIP: You can do this after you set your Display Banner location, the bot will updated the information automatically.
Pick which style of Display you'd like. The Bot supports Discord Embeds or Custom Banner Images.
- Use /bot banner_settings type (type) and select the type of display you'd like.
- If you picked Custom Banner Images you can customize the colors of the text via /server banner settings
See Banner How-to for usage and customization.

Launch Args

These are append to the command line when launching the bot. (eg. start.py -super)
- -token - Bypasse tokens validation check. (Mandatory for AMP Template Installations/Operations)
- -command - Enable slash command print statements for user traceback.
- -super - This leaves AMP Super Admin role intact, use at your own risk.
- -dev - Enable development print statments. (used for development)
- -debug - Enables DEBUGGING level for logging. (used for development)
- -discord - Disables Discord Intigration (used for testing)

Using Gatekeeperv2 as a Service

Log into your dedicated server/VPS via root.
You are then going to use the following command to create a service script for your Gatekeeper nano /etc/systemd/system/gatekeeper.service
- Once done, input the following information into the service file.

[Unit]
Description= GateKeeperv2
After= network.service

[Service]
Type= simple
WorkingDirectory= # This points to the directory of Gatekeeperv2 files (eg. '/home/gatekeeper')
ExecStart= #This points to the python3 script. (eg. 'ExecStart=/usr/bin/python3.9 /home/gatekeeper/start.py')
Restart= always 
RestartSec= 15

[Install]
WantedBy= multi-user.target

Then run these in the command line.

systemctl daemon-reload
systemctl enable gatekeeper.service
systemctl start gatekeeper.service

Useful Command

Use systemctl status gatekeeper.service to see the status of the Gatekeeper Service!

Thanks @LeviN

Credits

"Thank You" to everyone at CubeCoders Discord Server, especially IceofWrath, Mike, Greelan and everyone else in their discord.

"Thank You" to everyone over at Discord.py Discord Server, especially SolsticeShard and sgtlaggy for all the silly questions I kept asking about embed's and Hybrid messages!

Want to Support?

Visit my Patreon

k8thekat / GatekeeperV2