Installation
1
Download
Get the latest release from our Tebex store and download it from your Keymaster
2
Extract
Extract the script folder to your server’s
resources directory3
Configure
Add
ensure [script-name] to your server.cfg4
Customize
Configure the
config.lua file to match your server’s background optionsConfiguration
The script is configured through theconfig.lua file. Here are the main configuration sections:
Basic settings
Background configuration
Each background is defined with UI settings, gameplay settings, and optional custom functions:UI settings
Configure the user interface appearance and behavior:Adding custom backgrounds
To add a new background, add a new entry to theConfig.Backgrounds table:
Background configuration options
UI settings
Gameplay settings
Custom functions
Item configuration
Regular items
Weapon items
Items with metadata
Perk integration
The script integrates with weapon progression systems:Perk names and amounts should match your weapon progression system configuration.
Usage examples
Professional background example
Social background example
Framework integration
The script includes built-in support for multiple frameworks:Performance considerations
The script is optimized for performance with several key features:
- Efficient UI loading: Background images and data are loaded efficiently
- Minimal server impact: Background selection is processed quickly
- Configurable events: Optional event triggering to reduce overhead
- Debug mode: Can be disabled in production for optimal performance
Performance tips
- Image optimization: Use compressed images for background pictures
- Background count: Limit the number of backgrounds to essential options
- Custom functions: Keep custom functions lightweight and efficient
- Debug mode: Disable
Config.debugin production
Troubleshooting
Background not appearing
Background not appearing
Verify the background is properly added to Config.Backgrounds, check that the image file exists in the correct path, and ensure the configuration syntax is correct.
Items not being given
Items not being given
Confirm item names match your inventory system, check that weapons are properly marked with isWeapon = true, and verify the framework integration is working correctly.
Perks not applying
Perks not applying
Ensure perk names match your weapon progression system, verify perk amounts are valid, and check that the progression system is properly integrated.
UI not opening
UI not opening
Check that the trigger event is properly configured for your framework, verify the script is started in server.cfg, and ensure there are no console errors.
Custom functions not working
Custom functions not working
Verify the custom function syntax is correct, check that the function parameters are properly used, and ensure the function doesn’t contain errors that prevent execution.
Support
If you encounter issues or need assistance:Discord support
Join our Discord community for support and updates.
Documentation
Docs home - installation basics and links to every script.