# tb_welcome
## Compatibility
**No framework required!**
This resource works on any FiveM server—standalone or with any framework (ESX, QBCore, vRP, etc.).
It uses only native FiveM events and identifiers.
> A FiveM resource for displaying a customizable rules popup to new players, requiring them to agree before playing. Persistent agreement tracking included.
## Features
- Shows a rules popup (with "I Agree" button) when a player loads in for the first time
- Popup only appears once per player (tracked by license, even after server restarts)
- Rules are fully customizable in `config.lua`
- Clean, modern UI (NUI HTML)
- Easy to install and configure
## Installation
1. Place the entire `tb_welcome` folder in your FiveM server's `resources` directory.
2. Add `ensure tb_welcome` to your `server.cfg`.
3. Edit `config.lua` to set your server's rules and welcome message.
## How it Works
- When a player loads into the server for the first time, a popup with your rules appears.
- The player must click "I Agree" to continue. Their agreement is saved in `agreed.json`.
- On future joins, the popup will not appear for that player.
## Customization
- **Rules/Message:** Edit `config.lua` to change the rules or welcome message. Supports multi-line text.
## Example Rules (config.lua)
```lua
return {
welcomeMessage = [[
Welcome to ! Please read and agree to the following rules before proceeding:
Roleplay Server Rules:
1. No cheating, exploiting, or using unauthorized mods.
2. Be respectful to all players and staff at all times.
3. No hate speech, racism, or discrimination of any kind.
4. No griefing, trolling, or intentionally ruining others' experiences.
5. Use appropriate language in chat and voice.
6. No spamming or advertising other servers.
7. Follow all instructions from staff members.
8. Report bugs or issues to staff immediately.
9. Do not abuse glitches or game mechanics.
10. No random deathmatch (RDM) or vehicle deathmatch (VDM).
11. No powergaming (forcing actions on others without chance to respond).
12. No metagaming (using out-of-character info in character).
13. No combat logging (quitting to avoid RP consequences).
14. Stay in character at all times unless in OOC (out-of-character) chat.
15. Respect all roleplay scenarios and storylines.
16. No impersonating staff or emergency services unless permitted.
17. Do not steal vehicles or items from new players.
18. Use /ooc for out-of-character chat only when necessary.
19. No ERP (erotic roleplay) or inappropriate content.
20. Have fun and help others enjoy the server!
By joining, you agree to follow these rules. Enjoy your stay!
]]
}
```
## Troubleshooting
- If the popup does not appear, check your F8 and server console for errors.
- Make sure all files are present and resource name matches `tb_welcome`.
- If you want to reset agreement for all players, delete `agreed.json` (players will see the popup again).