Skip to content
A free and basic administration system for Garry's Mod.
Lua
Branch: master
Clone or download
Latest commit f8680fb Dec 3, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lua Add group change hooks. Dec 3, 2019
README.md newest credits Sep 18, 2019

README.md

xAdmin

A free and basic administration system for Garry's Mod.

What is xAdmin?

xAdmin is a lightweight and simplistic administration tool made with the intent to fit the gap that is currently made by these heavy and feature rich administation systems currently available on Garry's Mod. xAdmin tries to be lightweight and simplistic by only providing the core features needed. xAdmin doesn't even have a User Interface, it is 100% chat/console driven

Requirements

xAdmin currently requires MySQLoo in order to work. I have intentions to allow it to work internally at some point, but for now, it requires MySQLoo. Running xAdmin as is has no requirements, it's plug and play. If you wish to store your data in MySQL (Suggested), you will need the MySQLoo module installed on your server.

If it's simplistic, why should I use it?

Systems like ULX have the goal to be as feature rich as possible and meet the needs of everyone. xAdmin simply wants to provide the base utilities to help you and your team manage your servers.

A quick rundown

xAdmin is completely chat/console based when being interacted with in-game. This is to keep things as simple as possible. Like other popular admin systems, commands are (by default) prefixed with !. Running a command like !god Owain through chat will target and god the user Owain. All commands can also be run through the console with xadmin <command> <arguments>. When running chat commands, all words after the initial words are considered individual arguments. In order to pass multiple words as 1 argument, you can surround them in ". This will pass the collections of words as a single argument.

Install/Config

You can find a guide on installing and configuring xAdmin here. It should give you the general idea of how everything works along with a simple guide on how to install and configure it.

Documentation

I have created a simple wiki that documents every class and function that xAdmin has. It will show you the arguments they take and what they return. Some functions/classes may have notes informing you of extra information needed. For example: The ban function will not kick the user if they're online.

I have also documented all the default commands that come with xAdmin along with the arguments they take and what they do.

Contributions

I encourage you to contribute to this. If it's a small bug fix or adding a command, all contributions are welcome. If you spot a better way of doing something, submit it! The best way to improve shit is through collaboration.

Credits

You can’t perform that action at this time.