---

Adonis is a community-maintained server moderation and management system created for use on the Roblox platform.

⚠️ NOTICE

This version of Adonis is a WORK IN PROGRESS and is missing many features. For the current and supported version, see the Adonis 1.0 repository.

⚠️ DO NOT USE ADONIS 2.0 IN A PRODUCTION ENVIRONMENT! IT WILL NOT WORK. ⚠️

The following information on this page may not be accurate.

✨ Installation {#installation}

(WIP)

If you get stuck, feel free to ask for assistance in our Discord server.

Method 1 (recommended): Official Roblox Model {#method-1}

1. Take a copy of the Adonis loader model from the Roblox library
2. Insert the model into Studio using the Toolbox into ServerScriptService

Method 2: GitHub Releases {#method-2}

1. Download the rbxm file snapshot from the latest release
2. Import the model file into Studio

• Note: By default, snapshots included in releases have DebugMode enabled.

Method 3: Filesystem {#method-3}

1. Download the repository to your computer's file system
2. Install and use a plugin like Rojo to compile Adonis into a rbxmx file

• If using Rojo, you can run rojo build /path/to/adonis -o Adonis.rbxmx to build a rbxmx

3. Import the compiled model file into Studio

• Note: By default, loaders compiled from the repository have DebugMode enabled. This method compiles the bleeding edge version of Adonis, which may be unstable.

🛠️ Debug Mode {#debug-mode}

The Adonis loader provides a DebugMode option which will load a local copy of the MainModule rather than fetching the latest version. This could be useful if you want to stay on a particular version of Adonis or want to maintain a custom version for your game. Debug mode expects the MainModule to share the same parent with the loader model (e.g. both should be in ServerScriptService). By default, snapshots provided in releases have DebugMode enabled.

Toggling debug mode {#toggling-debug-mode}

1. Open Adonis_Loader > Loader > Loader
2. Change DebugMode at the end of the data table to the desired value (e.g. DebugMode = false)

🔗 Links {#links}

• Official Adonis Loader: https://www.roblox.com/library/7510622625/Adonis-Loader
• Official MainModule: https://www.roblox.com/library/7510592873/Adonis-MainModule
• Documentation: https://github.com/Epix-Incorporated/Adonis_2.0/wiki
• Discord Server: https://discord.gg/H5RvTP3

⭐ Contributing {#contributing}

The purpose of this repository is to allow others to contribute and make improvements to Adonis. Even if you've never contributed on GitHub before, we would appreciate any contributions that you can provide.

📜 Contributing Guide {#contributing-guide}

Read the contributing guide to get a better understanding of our development process and workflow, along with answers to common questions related to contributing to Adonis.

⚖️ License {#license}

Adonis is available under the terms of the MIT license.