Compare commits

...

2 commits

2 changed files with 7 additions and 0 deletions

View file

@ -26,6 +26,13 @@ This project aims to solve a simple but crucial problem: managing bans across ro
3. Configure the `.env` file with your database and API settings (see `.env.example`)
4. Run `node .` to start the server -->
## Usage on Roblox
1. Download the [UBS Main Module here](https://ubs.rtech.foundation/UnifiedBanSystem.rbxm)
2. Insert the module into your game
3. Move the module to `ServerScriptService`
4. Configure via the `Configuration` module, or just leave it as-is to use the default settings
5. Profit!
## API Documentation
### 🔓 Unauthenticated Endpoints
`GET /health` - Healthcheck endpoint (For Uptime Kuma)

Binary file not shown.