How epix-incorporated/adonis works
Project Type and Purpose
• This is an open-source, community-maintained admin/moderation system for Roblox games. It provides both server-side command handling and client-side UI components, delivered as a Roblox Model (.rbxmx) or via a Rojo build, and runs entirely within the Roblox runtime (Studio and Game Server).
High-Level File Structure Analysis
• Top-Level Folders
• Loader/ – The entrypoint “Adonis_Loader” model under ServerScriptService
– Config (Settings, API, Plugins, Themes)
– Loader.server.luau – reads Config, loads MainModule either remote or local (DebugMode)
• MainModule/ – Core logic split by execution context
– Client/ – Client-side controllers, core functions, remotes, UI library, theming, UI plugins
– Server/ – Server-side command definitions, core services (Admin, HTTP, Logs), third-party dependencies, datastore mocks, Plugins
– Shared/ – Common utilities, data structures, type checking, script‐loading helpers
• Ancillary Files
• build scripts (build.bat, build.sh, aftman.toml, default.project.json)
• CI/CD and lint configs under .github/ and selene.toml
• README.md, CONTRIBUTING.md, LICENSE, SECURITY.md
Key README Insights
• Loader Model is inserted in ServerScriptService.
• It can operate in DebugMode to load MainModule locally for development.
• MainModule is fetched by loader remotely in production, or loaded from the hierarchy in DebugMode.
• Configuration is driven entirely by the Settings Module under Loader/Config.
a. Main Components
1. Roblox Runtime
– Client (Players’ game clients)
– Server (Roblox Game Server)
– Core Roblox Services: Players, DataStoreService, HTTPService, RemoteEvents/Functions
2. Adonis Loader
– Config Module (Settings, API, Plugins list, Themes)
– Loader.server.luau
3. Adonis MainModule
– Client Side: Core controllers, UI themes, UI component library (Roact/Winro-based), Remote communication stubs
– Server Side: Command registry, Core (Admin, Anti-Cheat, HTTP wrapper, Logging, Process), Plugin loader, DataStore mocks for testing
– Shared: Utilities, Type checking, Data structures
4. External Dependencies
– Roblox’s DataStoreService (persistent key-value storage)
– Optional HTTP endpoints (Trello API, webhooks)
– Roact, Flipper, Maid, Sift, Signal, Winro (bundled in UI packages)
b. Relationships & Interactions
• Loader → MainModule: loads via require from either the network (Production) or local hierarchy (DebugMode)
• Client ↔ Server:
• Client components invoke server commands via RemoteFunctions/RemoteEvents defined in Shared/Remote.luau
• Server processes commands, uses Core and Plugins, writes/reads from DataStoreService
• Server emits updates back to clients (e.g., notification events, UI updates)
• Shared modules are required by both Client and Server to ensure consistency (e.g., Service.luau, Typechecker.luau)
• Config modules drive plugin registration on both Client and Server
c. Architectural Patterns & Principles
• Client-Server Partitioning: clear separation between client UI logic and server authority.
• Plugin Architecture: both client and server load feature modules from a Plugins directory, enabling extensibility.
• Configuration-Driven: central Settings module controls DataStore keys, debug flags, enabled plugins.
• Shared Codebase: common utilities and data models reused across contexts for consistency.
d. Technologies & Frameworks
• Luau (Roblox’s typed Lua dialect)
• Rojo (for local filesystem syncing)
• Roact, Flipper, Maid, Signal, Winro (for client UI components)
• Roblox RemoteEvents/RemoteFunctions (for RPC between client/server)
• Roblox DataStoreService (for persistence)