/Adonis

Roblox Server Administration System

Primary LanguageLuaMIT LicenseMIT

 

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

✨ Installation

📢 New to Adonis? Take a look at our official quick start video here or read the unofficial setup guide here.
If you get stuck, feel free to ask for assistance in our Discord server.

Method 1 (recommended): Official Roblox Model

  1. Take a copy of the Adonis loader model from the Roblox Library.
  2. Insert the model into Studio using the Toolbox, and place it under ServerScriptService. (Do not leave it in the Workspace!)

Method 2: GitHub Releases

  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

  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.
  1. Import the compiled model file into Studio.

ℹ️ Note: By default, loaders compiled from the repository have DebugMode enabled.

⚠️ Method 3 compiles the bleeding edge version of Adonis, which may be not fully tested and highly unstable.

⚙️ Configuring Adonis

Once you've inserted the Adonis loader into your game, open Adonis_Loader > Config > Settings, and change settings.DataStoreKey to something absolutely random (eg. "2fgi02e)^Q"). This is for security as it prevents serverside tampering with Adonis's datastores.

You may then edit the Settings module to configure Adonis to suit your game. Instructions and elaboration are provided within the Settings module.

🔧 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 are a contributor working on the MainModule, 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

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

🧪 Nightly Builds

Every time a commit is pushed to the master branch of the Adonis repository, a canary/"nightly" version of Adonis is automatically generated, containing the bleeding-edge changes. This will be published to the Nightly MainModule in the form of the loadable MainModule, and to the #nightly-builds channel in our Discord server in the form of the nightly Loader and MainModule assets for download, available for both public and internal testing.

Note that nightly builds should never be used in a production environment or live game as they are often unstable and may break entirely from time to time. Nightly builds are purely intended for testing and development.

🔗 Links

Assets

Reference

Social

Misc.

⭐ 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

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

Adonis is available under the terms of the MIT license. Read more details about the license here.

Thank you to our contributors!

contributors