Setup v3.3‐SNAPSHOT

🗝️ BetaKey - Advanced Beta Access System Wiki

Welcome to the official wiki for BetaKey - Advanced Beta Access System! Here you'll find comprehensive guides, tutorials, and documentation to help you make the most of BetaKey. Whether you're setting up the Bungee or Spigot plugins, integrating with a Discord bot, or configuring the website, we've got you covered.

📑 Table of Contents

• 🚀 Getting Started
• 🔌 Plugin - Bungee
• 🔌 Plugin - Spigot
• 🤖 Discord Bot
• 🌐 Website
• 🛠️ Support

---

📋 Project Overview

BetaKey - Advanced Beta Access System is designed to simplify and automate beta key distribution for your projects. It is versatile and can be integrated with multiple platforms to provide a seamless experience for your users.

• Version: 3.3-SNAPSHOT
• Supported Platforms: BungeeCord, Spigot, Discord, Apache 2.0
• More Details

🚀 Getting Started

To get started with BetaKey, follow these steps:

1. Download the latest version from the BuiltByBit page.
2. 📖 Read the Installation Guide below.
3. 🔧 Choose the platform you want to set up (Bungee, Spigot, Discord Bot, or Website).

🔌 Plugin - Bungee

Set up and configure the BetaKey plugin for BungeeCord.

1. 📂 Load the plugin into the plugins folder of the BungeeCord server (only the proxy, not sub-servers).
2. 🔄 Restart the server, then enter your Database credentials in Config.yml and whitelist your Minecraft username.
   • Database Management System (DBMS) options: mysql, mariadb, sqlite, and postgresql.
   • ⚠️ Please note: sqlite and postgresql have not been thoroughly tested.
3. 🛡️ Restart the server again, give yourself the permission betakey.admin, and manage keys using the command /betakey.

🔌 Plugin - Spigot

Instructions for installing and using the BetaKey plugin with Spigot.

1. 📂 Load the plugin into the plugins folder of your Spigot server.
2. 🔄 Restart the server, then enter your MySQL credentials in Config.yml and whitelist your Minecraft username.
   • Database Management System (DBMS) options: mysql, mariadb, sqlite, and postgresql.
   • ⚠️ Please note: sqlite and postgresql have not been thoroughly tested.
3. 🛡️ Restart the server again, give yourself the permission betakey.admin or OP, and manage keys using the command /betakey.

🤖 Discord Bot

Integrate BetaKey with your Discord server to automate beta key distribution.

1. 🆕 Create an Application in Discord's Developer Portal.
2. 🔑 Reset a Token for your Application and copy the token to the config in Bungee or Bukkit server /plugins/BetaKey/config.yml.
3. 📋 Enable Discord Developer Mode and get the role ID of the link role. Paste the role ID into the config in Bungee or Bukkit server /plugins/BetaKey/config.yml.
4. 🟢 Adjust bot status to:
   • 🟢 ONLINE
   • 🌙 IDLE
   • ⛔ DO_NOT_DISTURB
   • 🔘 INVISIBLE
5. 🎮 Set the bot activity to:
   • 🎮 PLAYING
   • 🎧 LISTENING
   • 📺 WATCHING

🌐 Website

Set up and manage the BetaKey distribution system through your website.

1. 🖥️ Upload the website files to your web server (/var/www/html).
2. 🔧 Enter your Database credentials in MYSQL.php to complete the setup.

🛠️ Support

If you encounter any issues or have questions, please refer to our Discord Server. We're here to help you troubleshoot and ensure you get the best out of BetaKey.