This script provides an immersive character creation experience with diverse background options, each offering unique starting conditions, skills, and equipment to shape your character’s journey.
Features
Diverse Backgrounds
Choose from multiple character backgrounds including Hunter, Herbalist, Veteran, and many more, each with unique starting conditions.
Customizable Starting Items
Each background provides specific starting items, weapons, and equipment relevant to the character’s profession and experience.
Perk Integration
Seamless integration with weapon progression systems, providing starting skill levels based on character background.
Immersive UI
Beautiful, immersive user interface with background images and detailed descriptions for each character option.
Custom Events
Support for custom server-side events and functions to handle background-specific logic and interactions.
Framework Integration
Compatible with VORP Core and RSG Core frameworks with modular framework bridge support.
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.cfg
4
Customize
Configure the
config.lua
file to match your server’s background optionsConfiguration
The script is highly configurable 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:Background Types
The script includes a variety of pre-configured backgrounds:Professional Backgrounds
Hunter
Hunter
A skilled character experienced in hunting and wilderness survival. Starts with hunting perks, bow, and arrows.
Herbalist
Herbalist
A wise healer familiar with nature’s remedies. Starts with herbalism perks and medical supplies.
Miner
Miner
A hardened miner experienced in extracting ores. Starts with mining perks and mining tools.
Lumberjack
Lumberjack
A strong lumberjack skilled with axes. Starts with lumber perks and logging equipment.
Farmer
Farmer
A hardworking farmer dedicated to crops and livestock. Starts with farming perks and agricultural tools.
Specialized Backgrounds
Medic
Medic
A trained healer with extensive medical knowledge. Starts with medical perks and healing supplies.
Veteran
Veteran
An experienced veteran with military training. Starts with gunslinger perks and military equipment.
Horse Trainer
Horse Trainer
An experienced horse expert. Starts with horse care items and a horse token.
Fisherman
Fisherman
A patient fisherman who knows the waters. Starts with fishing perks and fishing equipment.
Cook
Cook
A talented cook who can prepare delicious meals. Starts with cooking perks and culinary supplies.
Social Backgrounds
Wealthy Heir
Wealthy Heir
A wealthy heir accustomed to luxury. Starts with significant money and luxury items.
Swindler
Swindler
A cunning con artist who gets by with trickery. Starts with lockpicks and minimal money.
Homeless
Homeless
A penniless loner with bare essentials. Starts with minimal items and negative money.
Civilian
Civilian
An ordinary settler making their way in the West. Basic starting conditions.
Adding Custom Backgrounds
To add a new background, simply 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.
Framework Integration
VORP Core
RSG Core
Custom Framework
Usage Examples
Professional Background Example
Social Background Example
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.debug
in 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.
Framework Integration
The script includes built-in support for multiple frameworks:Limitations
Be aware of the following limitations when configuring the script:
- Image Requirements: Background images must exist in the specified path
- Item Compatibility: Items must be compatible with your inventory system
- Perk Integration: Perk names must match your weapon progression system
- Framework Events: Custom events must be properly configured for your framework