This HUD was designed to facilitate and augment roleplay. It supports a currency, loot drops, crafting machines, daily pay, an optional titler, and, of course, a HUD.
Initially built to provide a HUD without in-game mechanics for a now-defunct roleplay sim, it is being made available for everyone to use however they want. The only rights on this code is the right for everyone to use what is here on this repo so long as it doesn't infringe on this right.
This system employs a hash seed to mitigate MITM attacks. Should your seed ever be compromised, you should change it immediately.
I hope you enjoy your RP.
Sylas
The code uses Firestorm LSL Preprocessor directives. Edit global settings in config.lsl.
NOTE: These are not the only settings you need to adjust. Check source code for per-file settings.
Setup steps:
- [REQUIRED] config.lsl
- [REQUIRED] Database & server-side configuration
- Create Admin HUD
- Create Player HUD & Titler
- Setup looting system
- Setup daily check-in
- Create quests
- Create a MySQL database with tables for the HUD using mysql-db-creation.sql.
- Assign a database user.
- Update the connection details in api.php.
- Populate the
$hash_seedvariable with a random string to be used to help secure your system. It is also the value in quotes in the config.lsl file -- they must match. - Set the correct defaults for Player.php class constants.
Script: sl-rp-admin-hud-controller
This script works by including in any object which attaches as a HUD. When the object is clicked, the menu will be displayed.
Script: sl-rp-player-hud
Stats are displayed as hover text on an object containing the script with a HUD attachment point.
Change default_texture to a UUID or the name of a texture in the inventory of the object which represents the texture to display for the current version of the HUD. When out of date, this texture will be switched to white. In some cases the current version broadcast is incorrectly received causing the HUD to white. End users can click the HUD to re-validate the version.
Script: sl-rp-player-titler
Just put Player Titler an object and set the attachment point. The Player Titler has no configuration options.
The looting system is comprised of 4 different items:
- Crafting items
- Usable items
- Loot drops
- Crafting machines
Script: N/A
Crafting items are items used by crafting machines and created by someone in the config.lsl's CREATORS list.
Script: sl-rp-consumable-item
Experience, health, attack, defense, attack boost, defense boost, and currency can be affected (one or more at the same time) by a usable item. Attack boost and defense boost are currently placeholders and are not functional. Adjust the variable value in double quotes at the top of the file. Positive numbers increase stats, negative numbers decreate stats. Levels are increased automatically if experience is increased or decreased.
Usable items can be attached or they can be rezzed. Rezzed usable items can be used by anyone within 5 meters (for sharing, stealing, or bonus drops).
When a usable item is clicked, it sends the stat changes to the HUD. The HUD sends the changes to the server, verifies that the change was successful, and sends the item a success confirmation. When a success confirmation is received, the item's texture is changed to the value of used_texture_uuid (default is a red/trans stripe texture) and the script itself is deleted. If a response is not received in 15 seconds, a message is sent to the player.
Script: sl-rp-loot-drop
You must configure each of these variables:
machine_name-- The name of the crafting machine logged in the database.droppables-- See Thedroppablesvariablemax_distance_from_object-- The player must be closer than this number of meters from the object.min_level-- The player's minimum level to use this item.cooldown_seconds-- The average time players must wait before using this item.cooldown_seconds_variation_percent-- The decimal form percentage ofcooldown_secondsdefining the min and max time players must wait before using this item. See Thedroppablesvariable for details.success_msgdamage_msghealth_damage_probability_percent-- The chance (percentage 0 to 100 as an integer) of a player losing health when using the loot drop in addition to receiving the item.health_damage_amount-- The amount of health to subtract based onhealth_damage_probability_percent.xp_penalty_probability_percent-- The chance (percentage 0 to 100 as an integer) of a player losing experience when using the loot drop in addition to receiving the item.xp_penalty_amount-- The amount of experience to subtract based onxp_penalty_probability_percent.
droppables is a strided list of the format "_ITEM_NAME_", (integer)relative_weight. For example, if we have apple, banana, and orange, the list might look like this:
list droppables = ["apple", 1,
"banana", 2,
"orange" 3
];
The relative weights determine how likely each item is to be selected. In the example above, the sum of the relative weights is 6. That means a 1/6 (16.67%) chance of getting an apple, a 2/6 = 1/3 (33.33%) chance of getting a banana, and a 3/6 = 1/2 (50%) chance of getting an orange. The numbers must be integers and can be larger.
Cooldowns apply to each player. When a player receives a loot drop item, a time delay is calculated and sent to the server. The player can receive another item from this loot drop after the delay. For example, if the cooldown_seconds is 3600 (1 hour) and the cooldown_seconds_variation_percent is .25, then the time selected will be 45 minutes to 1 hour 15 minutes, 1 hour ± 15 minutes (.25 * 1 hr). This promotes roleplayers remaining on the sim.
DROPS_PER_24_HOURS sets the maximum number of drops per player for a 24 hour rolling window.
Crafting machines have a recipe requiring one or more crafting or usable items, then delivers a different crafting or usable item, deleting the items used in the recipe.
One of two objects are delivered. Each crafting machine must be made of 2 prims: (1) The root prim containing the good object and the sl-rp-crafting-machine script and (2) a linked prim containing a critical failure object and the script sl-rp-crafting-machine-crit-failure.
The root object of the crafting machine must contain the sl-rp-crafting-machine script with these variables configured:
machine_name-- The name of the crafting machine used in both the root object and the linked object containing sl-rp-crafting-machine-crit-failure.ingredients-- Strided list of the format"_ITEM_NAME_", (integer)qty_required, 0(The last 0 is used as a placeholder when counting players' dropped items.)produced_item-- The name of the inventory object (Content tab) given when all required recipe items added to the Content tab in both the root object and the linked object with the sl-rp-crafting-machine-crit-failure script.min_level-- The minimum required player level to use this crafting machine.failure_messagesuccess_rate-- The percentage (an integer between 0 and 100) likelihood of theproduced_itemin the root object being given. Ifsuccess_ratedoes not result in theproduced_itemin the root object being given, all required recipe items added to the Content tab are deleted and thefailure_messagemessage is sent to the player.crit_fail_rate-- The percentage (an integer between 0 and 100) of those who received thefailure_messagemessage who will receive the item in the linked object containing the sl-rp-crafting-machine-crit-failure script.crit_fail_rate_damping_by_level_above_min_levelFor each level abovemin_level, this number is subtracted fromcrit_fail_rate(never going below zero).
The linked object containing the sl-rp-crafting-machine-crit-failure script object must be the same name as the produced_item.
Script: sl-rp-daily-checkin
machine_name is used for logging.
The scripts provided give you all you really need for quests, but you will need to be a scripter to understand how. I don't currently plan on putting these out there, but if there are generalized ones people are willing to contribute, awesome!