Skip to main content

Creating Your First HUD

In this guide, you will learn how to set up your first HUD integrated with the CaveTech Web Dashboard. The process is straightforward, and by following the steps correctly, your HUD will be fully functional and connected to the external dashboard.


✅ Step 1: Configure the Receiver Object

In the object you want to control (for changing colors, textures, materials, etc.), add the following script:

  • 📄 Script: CaveTech_obj_Config

📝 Important: Always reset the object after adding the script to ensure proper functionality.


✅ Step 2: Configure the HUD Object

In the HUD object (responsible for managing buttons and interactions):

  1. Add the script CaveTech_Hud_Controller.
  2. Wait at least 5 seconds after adding the first script.
  3. Add the script CaveTech_Hud_License to activate the HUD.

Visual Confirmation: The script CaveTech_Hud_License will automatically disappear after activation, which means it worked correctly.

🚨 Warning: If you skip this activation step, your HUD will not function with the web dashboard.


✅ Step 3: Connect the HUD to the Web Dashboard

In the same HUD object:

  • Add the script CaveTech_scanner.

🔗 This script is responsible for communicating your HUD directly with the CaveTech Web Dashboard, allowing you to configure everything online without using notecards.


✅ Step 4: Finalize the Setup

To complete the setup:

  • Reset the receiver object (with CaveTech_obj_Config).
  • Reset the HUD object (with CaveTech_Hud_Controller and CaveTech_scanner).

🎉 All done! Your HUD is now configured in-world and connected to the CaveTech Web Dashboard.


Next Steps

After setting up your first HUD, continue with:

  1. HUD Configuration - Learn to configure your HUD through the web dashboard
  2. Interface Designer - Customize your HUD's appearance
  3. Data Binding - Connect your HUD to dynamic data sources
  4. Performance Optimization - Optimize your HUD for better performance

If you encounter any issues during setup, please contact support.