tibynx/pyxis repository overview

⁠🧭 Pyxis⁠

Pyxis is a versatile Discord bot designed to streamline member invitations and enhance server security. It allows your server members to create one-time-use invite links that they can only use. It's perfect for creating a secure private server, ban appeals, or games. Additionally, it provides powerful management tools to lock down your server in case of raids or other security concerns.

⁠Features

• Secure One-Time Invites: Generates unique, one-time-use invite links for specific users.
• Impersonation Protection: Automatically detects and kicks unauthorized users who attempt to join using someone else's invite link.
• Server Lockdown Mode: Instantly pause invites and DMs between members to protect against raids.
• Bulk Invite Purging: Quickly clear all active invites on the server with a single command.
• Configurable Timeout & Indicators: Customize invite expiration times and status emojis.

⁠Commands

⁠Setup

⁠Prequisites

1. Create an application on the Discord Developer Portal⁠
   • Click "New Application" and give it a name.
   • Note down the Application ID for later.
   • Go to the "Bot" tab and click "Add Bot".
   • Under "TOKEN", click "Copy" to copy your bot token. (You might need to reset it to see it.)
   • Enable the "Server Members Intent" and "Presence Intent" options.
2. Enable developer mode in Discord to copy guild and channel IDs
   • Go to User Settings > Advanced > Developer Mode and enable it.
3. Invite the bot to two Discord servers. One where you want your members to join from, and one where they gonna join to. You can use the premade link in the usage section.

Now choose one of the following methods to run the bot!

⁠Source

1. Clone the repository and install all required packages! Python 3.14 is recommended!

   git clone https://github.com/tibynx/pyxis.git
   cd pyxis/
   pip install -r requirements.txt
   

   Copy
2. Copy .env.example to .env and configure your settings.
   • See the configuration section below for details!
   • On Discord, right-click on the server icon or channel and select "Copy ID" to get the IDs.
   • Do not share your .env file publicly!
3. Run python main.py to start the bot.

⁠Docker

1. Pull the latest image from Docker Hub

   docker pull tibynx/pyxis:latest
   

   Copy
2. Run the container with the required environment variables and volume mounts
   • See the configuration section below for details!
   • Change /path/to/logs to a directory on your host where you want to store the logs.

   docker run -d \
   --name=pyxis \
   -e BOT_TOKEN="your_bot_token_here" \
   -e SYNC_GUILD="your_server_id_here" \
   -e TARGET_GUILD="your_server_id_here" \
   -e TARGET_CHANNEL="your_channel_id_here" \
   -e COMMAND_DESCRIPTION="Get an invite link to join the server" #optional \
   -e INVITE_TIMEOUT="300" #optional \
   -e ONLINE_MEMBER_INDICATOR="🟢" #optional \
   -e TOTAL_MEMBER_INDICATOR="⚪" #optional \
   -v /path/to/logs:/app/logs \
   tibynx/pyxis:latest
   

   Copy

⁠Configuration

The emoji format can be either a Unicode emoji (e.g., 👥) or a custom emoji in the format <a:name:id> (e.g., <a:people:733395207222984794>). The bot must be in the server where the custom emoji is from or added to the bot on the Discord Developer Portal to use it.

⁠Usage

Invite your bot to the servers using this premade link! It already contains the proper permissions. Replace YOUR_APP_ID with your bot's Application ID. Make sure to invite the bot to both the SYNC_GUILD and TARGET_GUILD servers!

https://discord.com/oauth2/authorize?client_id=YOUR_APP_ID&permissions=35&integration_type=0&scope=bot+applications.commands