RTECH/UBS
3
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: RTECH:c588cca05df5002c7b99bb11cb975ac69a9a2bf8
Branches Tags
RTECH:main
..
compare: RTECH:a4b7e7245268ef776d47e399874b4a06d8e9fcb6
Branches Tags
RTECH:main

2 commits
c588cca05d ... a4b7e72452

Author SHA1 Message Date
Christopher Cookman a4b7e72452 Update README.md with install instructions for roblox module 2024-12-23 08:17:21 -07:00
Christopher Cookman 9343a98766 Update UBS script 2024-12-23 08:15:11 -07:00
2 changed files with 7 additions and 0 deletions
Show stats Expand all files Collapse all files

7
README.md
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`) 3. Configure the `.env` file with your database and API settings (see `.env.example`)
4. Run `node .` to start the server --> 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 ## API Documentation
### 🔓 Unauthenticated Endpoints ### 🔓 Unauthenticated Endpoints
`GET /health` - Healthcheck endpoint (For Uptime Kuma) `GET /health` - Healthcheck endpoint (For Uptime Kuma)

BIN
public/UnifiedBanSystem.rbxm
View file

Binary file not shown.