Adonis Server Moderation and Management System

repository·master·Indexed 19 days ago

https://github.com/epix-incorporated/adonis

A community-maintained server moderation and management system for the Roblox platform. It provides administrators with tools for player moderation, server management, and game-wide configuration. Features include rank and permission management, server whitelisting, broadcast notifications, player notes, and a wide array of administrative commands for server control and player disruption.

Tokens
25.9K
Snippets
166
Records
174
Agent score
67%

What's inside Adonis

  1. Use Debug Mode for Development

    master

    The DebugMode feature is intended for development and debugging only. It enables features such as exposing a debugging API, enabling debugging commands for Creators, and preventing the model from being protected (e.g., not parenting it to nil).

    When DebugMode is enabled, the loader will load a local copy of the MainModule from the same parent (e.g., ServerScriptService) instead of fetching the latest version from Roblox. This is useful for contributors working on the MainModule.

    To toggle Debug Mode:

    1. Open Adonis_Loader > Loader > Loader.
    2. Locate the data table.
    3. Change the DebugMode value at the end of the table to true or false.
    -- Inside Adonis_Loader > Loader > Loader
    local data = {
        -- ... other settings ...
        DebugMode = false -- Set to true to enable debug features
    }
  2. Install Adonis via the Official Roblox Model

    master

    The recommended way to install Adonis is by using the official loader model from the Roblox Library.

    1. Take a copy of the Adonis loader model from the Roblox Library.
    2. Insert the model into Roblox Studio using the Toolbox.
    3. Place the model under ServerScriptService. Do not leave it in the Workspace.
    # No code snippet provided for Roblox Library installation
  3. Install Adonis via Filesystem and Rojo

    master

    For developers working with a local filesystem, you can compile Adonis using Rojo. Warning: This method compiles the bleeding edge version of Adonis, which is highly unstable and may not be fully tested.

    1. Download the repository to your local machine.
    2. Use Rojo to compile the repository into an .rbxmx file.
    3. Import the resulting .rbxmx file into Roblox Studio.

    If using Rojo, you can build the file using the following command:

    rojo build /path/to/adonis -o Adonis.rbxmx
  4. How player selectors work

    master

    Adonis uses a powerful selection system to target players in commands. You can use the following selectors:

    • me: Yourself
    • all: Everyone in the server
    • admins: All admins in the server
    • nonadmins: Normal players
    • others: Everyone except yourself
    • random: A random player (excluding those removed via -SELECTION)
    • @USERNAME: A specific player by exact username
    • #NUM: A specific number of random players (e.g., #5 targets 5 random players)
    • friends: Your friends currently in the server
    • %TEAMNAME: Members of a specific team
    • $GROUPID: Members of a specific Roblox group
    • radius-NUM: Anyone within a certain stud radius of you
    • t-TAG_NAME: Anyone with a specific tag (tags cannot contain spaces; spaces are converted to _)
    • stat/NAME/MIN/MAX: Players matching a leaderboard stat (e.g., stat/wins/5/8 targets players with 5 to 8 wins)

    Modifiers:

    • -SELECTION: Inverts the selection (removes the selection from the list).
    • +SELECTION: Re-adds the selection to the list.
  5. Use batch commands and repetition

    master

    You can chain multiple commands together or repeat them using specific syntax:

    • Multiple Commands: Use the batch key (defined in settings) to run several commands in one line.
    • Delay: Add !wait <seconds> between batch commands to introduce a pause.
    • Repetition: Use repeat <count> <delay> <command> to run a command multiple times with a set interval.

    Example of repetition:

    !repeat 10 1 !respawn jim
  6. Configure Adonis Settings and Security

    master

    After inserting the Adonis loader, you must perform a critical security step to prevent server-side tampering with Adonis's datastores.

    1. Navigate to Adonis_Loader > Config > Settings.
    2. Locate settings.DataStoreKey.
    3. Change settings.DataStoreKey to a unique, random string (e.g., "2fgi02e)^Q").

    You can further customize Adonis by editing the Settings module; detailed instructions and options are provided within the module itself.

    -- Example of what to look for in Settings module
    settings.DataStoreKey = "YOUR_RANDOM_STRING_HERE"
  7. Configure Adonis Settings and Plugins

    master

    Adonis uses a modular configuration structure located within the Config folder. Use these modules to customize the administrative experience:

    Module PathPurpose
    Config -> Settings -> RanksDefine user ranks and permissions
    Config -> Settings -> GeneralSet command prefixes and general behavior
    Config -> SettingsAccess various category-specific settings
    Config -> PluginsAdd custom commands and plugin logic
  8. Install and Setup Adonis

    master

    To set up Adonis, it is recommended to store the Adonis_Loader in ServerScriptService.

    Once installed, you can manage the system through the following configuration paths:

    • Ranks: Configure user permissions in Config -> Settings -> Ranks.
    • General Settings: Configure prefixes and command settings in Config -> Settings -> General.
    • Other Settings: Additional settings are categorized in Config -> Settings.
    • Extensions: Create custom commands and plugins in Config -> Plugins.
  9. Use Donor commands for character customization

    master

    The Donors admin level provides a suite of commands for character customization, including visual effects, clothing management, and avatar item retrieval. These commands use the configured Settings.PlayerPrefix (e.g., / or ;).

    Visual Effects

    • Neon Body: Changes your body material to neon and optionally sets a color.
    • Fire: Adds a fire effect to your character with an optional color.
    • Sparkles: Adds sparkles to your character with an optional color.
    • Light: Adds a PointLight to your character with an optional color.
    • Custom Particles: Apply a custom particle emitter using a specific Texture ID and color sequences.

    Clothing and Accessories

    • Avatar Items: Retrieve specific items (hats, shirts, pants, etc.) by their Asset ID.
    • Outfit Management: Save your current appearance to persist across respawns or revert to your default look.
    • Hat Management: View, remove specific, or clear all currently worn accessories.