Ban Screen 1.0.0
Installation
1. Place the `ban` folder inside `resources/`
2. Add to your `server.cfg`: ensure ban
3. Open `config.lua` and set `Config.DbPath` to the full path of your `playersDB.json`
4. go to txadmin and /settings and disable ban checking
Configuration
All settings are in `config.lua`.
| Option | Default | Description |
|---|---|---|
| `Config.DbPath` | *(your path)* | Full path to txAdmin's `playersDB.json` |
| `Config.CardPath` | `'ban_card.json'` | Path to the Adaptive Card template |
| `Config.DateFormat` | `'%d.%m.%Y %H:%M'` | Date format for ban/expiry dates |
| `Config.PermanentLabel` | `'Permanent'` | Label in date fields for permanent bans |
| `Config.PermanentRemainingLabel` | `'PERMANENT'` | Label in the time remaining field |
| `Config.ExpiredLabel` | `'Expired'` | Label when a temporary ban has expired |
| `Config.StatusPermanent` | `'permanent'` | `{{statusType}}` value for permanent bans |
| `Config.StatusTemporary` | `'temporary'` | `{{statusType}}` value for temporary bans |
| `Config.FallbackKickMessage` | `'You are banned...'` | Kick text used when the card fails to load |
| `Config.DeferralMessage` | `'Checking ban status...'` | Message shown during the ban check |
| `Config.LogoUrl` | Discord CDN URL | Logo shown at the top of the ban card |
| `Config.DiscordUrl` | `'https://primeleaks.cc'` | URL opened by the Discord button |
Ban Card Template Variables
Available in `ban_card.json`:
| Variable | Description |
|---|---|
| `{{reason}}` | Ban reason |
| `{{id}}` | Ban ID |
| `{{author}}` | Admin who issued the ban |
| `{{date}}` | Date the ban was created |
| `{{expiration}}` | Expiry date or "Permanent" |
| `{{playerName}}` | Connecting player's name |
| `{{statusText}}` | `PERMANENT` or `TEMPORARY` (uppercase) |
| `{{statusType}}` | `permanent` or `temporary` (lowercase) |
| `{{timeRemaining}}` | Time left (e.g. `2d 4h 30m`) or `PERMANENT` |
| `{{logoUrl}}` | Value of `Config.LogoUrl` |
| `{{discordUrl}}` | Value o
Shared by Modrelease Bot
