Version 1.1.7
86 downloads
WelcomePlus is a lightweight, community-driven plugin developed to make your server feel welcoming with personalised greeting messages that actually matter.
Features
- Rank-Based Welcome Messages - Customisable messages based on player permissions
- Playtime Tracking - Track total playtime and current session time
- Interactive GUI - Modern interface accessible via `/wp` or `/welcomeplus`
- Multi-Language Support - English and Spanish included, easy to add more
- Admin Tools - Player lookup, statistics, and data management
- Opt-Out System - Players can disable automatic welcome messages
- Command Aliases - Fully configurable command aliases
- External Language Files - Easy translation management via JSON files
- Separate Welcome Messages File - Edit welcome messages independently from language files
Permissions
- `welcomeplus.use` - Required to receive welcome messages (if enabled in config)
- `welcomeplus.vip` - VIP rank permission
- `welcomeplus.admin` - Admin rank permission
- `welcomeplus.owner` - Owner rank permission
Custom Rank Permissions: Define your own ranks and permissions via the config file's `CustomRankPermissions` block.
Installation & Setup
1. Download and drop `WelcomePlus.cs` into your `oxide/plugins/` folder
2. Download and place the `lang/` folder in `oxide/lang/WelcomePlus/`
3. (Optional) Place `WelcomePlus_WelcomeMessages.json` in `oxide/data/` for custom welcome messages
4. Restart your server or run `oxide.reload WelcomePlus`
5. Configure ranks and permissions in the generated config file (optional)
6. Customise welcome messages in `WelcomePlus_WelcomeMessages.json` (optional)
That's all - the plugin works out of the box with sensible defaults!
Quick Start Commands
Players:
- `/wp` - Open main menu
- `/playtime` or `/pt` - View your playtime
- `/session` - View current session
- `/playtimeleaderboard` or `/ptl` - View top 10 players
Admins:
- `/wp stats` - Plugin statistics
- `/wp reset <player>` - Reset player data
- `/wp defaults` or `/wp resetconfig` - Reset config and welcome messages to defaults
- `/playtime <player>` - View any player's stats
Configuration
The plugin generates a config file at `oxide/config/WelcomePlus.json` with all settings. Key options:
- Custom Rank Permissions - Define rank labels and their permissions
- UI/Text Toggle - Choose between GUI panels or chat messages
- Welcome Settings - Enable/disable first-time and returning player messages
- Command Aliases - Customise all command aliases
- Welcome Messages File - Edit welcome messages in `oxide/data/WelcomePlus_WelcomeMessages.json`
- Reset to Defaults - `/wp defaults` command resets config and welcome messages to defaults
Welcome Messages File
Welcome messages are stored in `oxide/data/WelcomePlus_WelcomeMessages.json` (automatically created on first run). This file contains all rank-specific welcome messages and is separate from language files for easier editing.
File Structure:
- `FirstTime` - Messages for first-time players (by rank)
- `WelcomeBack` - Messages for returning players (by rank)
- Supports multiple messages per rank (randomly selected)
- Supports placeholders: `{name}`, `{rank}`, `{total}`, `{session}`
Language Files
Language files are in `oxide/lang/WelcomePlus/`:
- `en.json` - English (default)
- `es.json` - Spanish
To add more languages, create new JSON files (e.g., `fr.json`) following the same structure.
Note: Language files contain UI text and system messages. Welcome messages are primarily stored in the welcome messages file, with language files as fallback.
Custom Ranks
Define custom ranks in the config:
```json
"CustomRankPermissions": {
"default": "",
"vip": "welcomeplus.vip",
"mod": "welcomeplus.mod",
"staff": "welcomeplus.staff",
"admin": "welcomeplus.admin",
"owner": "welcomeplus.owner"
}
```
Priority System:
- Rank priority is determined by config order (first entry = highest priority)
- If a player has multiple permissions, the rank appearing first in config wins
- Example: If "staff" appears before "mod" and player has both, "staff" messages are used
Automatic Permission Registration:
- Permissions from `CustomRankPermissions` are automatically registered
- No code changes needed - just add to config and reload
Then add rank-specific messages to `WelcomePlus_WelcomeMessages.json`:
- Add rank key to `FirstTime` section for first-time messages
- Add rank key to `WelcomeBack` section for returning player messages
- Messages fall back to language files if not found in welcome messages file
Support
Discord: @olvrdncnsctt
For detailed documentation, see `README.txt`. For version history, see `WelcomePlusChangelog.txt`.
README.txt
WelcomePlusChangelog.txt