Get it from Microsoft Store
Helox Engine documentation

Engine starter

1
New Project: Click it to create a new project.
2
2. Open Workspace: Open a project from a friend or a shared project that you are developing together.
3
3. Search Projects: Use this option to search for projects by name.

Delete a Project: To delete a project, right-click on its project card. A context menu will appear. Select Delete to permanently remove the project.

After clicking New Project, a window will appear with three options:

1
Project Name: Enter the name of your project.
2
Build Version: Select the engine version your project will use.
3
Location: Choose the folder where your project files will be stored.

Heolx Engine – Editor Interface

The main editor interface is divided into several sections:

1
Main Toolbar: Contains the main editor controls and tools
Save: Saves the current project. Select Mode: Opens the available selection and editing modes. Clouds: Controls the sky environment using 360° skybox images to create the sky appearance. Fog: Controls fog settings and appearance. Play: Starts the project. Stop: Stops the running project. More Options: Opens additional controls.
2
Details Panel: Displays the properties and settings of the selected object in the scene.
3
World Panel: Displays the objects and elements added to the current scene, allowing you to manage them.
4
Asset Browser: Displays the project's content, including imported models, textures, sounds, folders, and other assets.
Content Browser: Browse and organize project files. Import: Import new assets into the project. Search Content: Search for assets by name. Folders: Browse and organize the folders containing your project assets.

Asset Browser (Content Drawer)

Folder Tree Hierarchy (Left Panel): Displays the entire project's directory structure in an expandable tree view for rapid navigation: Content (Root): The root directory containing all project data. Control: Contains core game framework folders: Elements: Holds core asset categories including: 3D: 3D models and skeletal meshes (.fbx....). Images: Displays and stores images and textures only. Labels: Saved character, player, and enemy weapon setups. Levels: Contains map, environment, and world scene files. 2. Import Button (📥 Import): Opens the import window to import external 3D models and images directly into the currently active folder. 3. Asset Display Grid (Main Area): Visualizes all folders and asset files inside the selected directory (e.g., displaying the 3D, Images, Labels, and Interactive M... folders when inside Elements). Clicking any folder opens its contents. 4. Navigation & Search Bar (Top Right): Navigation History (Back < / Forward >): Move backward or forward through folder history. Breadcrumbs Path: Shows the active file path (Content > Control > Elements) with one-click folder jumping. Search Content Bar: Quickly searches and filters assets by name across the current directory.


Import Asset Window

Brings external files into your project. Switch between two modes at the top: Images (textures and video) and Model (3D models).

1. Mode Switch (Images / Model):

Choose what you want to import. The options below change with the mode.

2. Upload Area:

Click the capsule at its bottom edge, or drag files from Windows Explorer and drop them on the area.

3. Images Option:

Pick Images to import textures (.png, .jpg, .jpeg, .bmp, .webp, .tga, .dds, .tif). They are copied to Images/Textures.

4. Video (mp4) Option:

Pick Video (mp4) to import mp4 files only. They are copied to Images/Videos, and any other file type is skipped.

5. Video Cards:

Each video appears as a card with a frame from the video as its preview. Double-click it to open the player (Play/Pause, seek bar, volume).

6. Status Line:

Shows the last import result: file name or count, and any skipped files or warnings.

Import Asset 
Images 

Details Panel (Right Panel)

. TRANSFORM:

Controls the 3D spatial positioning and dimensions of the object in world coordinates:

Location (X, Y, Z): Sets the physical coordinate position in the 3D world.

Rotation (X, Y, Z): Adjusts the object's orientation angles (Pitch, Yaw, Roll).

Scale (X, Y, Z): Controls the size and proportion multipliers along each axis.

2. STATIC MESH:

Defines the 3D geometry assigned to the object:

Static Mesh Selector: Displays the active 3D model (e.g., dragon) and allows swapping or selecting a different mesh from the project assets.

3. MATERIALS:

Controls the visual surface shading and color of the mesh:

Element 0: Assigns the material asset to the mesh surface slot.

Albedo (RGB): Adjusts the base diffuse color tint across the Red, Green, and Blue color channels (e.g., 204, 204, 204).

4. RENDERING:

Configures dynamic lighting and shadow behavior:

Cast Shadow (Off / On): Enables or disables the object's ability to cast shadows onto other surfaces.

Receive Shadow (Off / On): Determines whether the object displays shadows cast by other geometry.

5. REFLECTIONS:

Force Reflection: Forces dynamic surface reflections onto the object regardless of global reflection bounds.

6. PHYSICS:

Controls physical simulation and collision feedback:

Simulate Physics (Off / On): Enables realistic gravity, velocity, and physical collisions.

Mass (Kg): Sets the weight of the object in kilograms (e.g., 1.00).

Footstep Sound (Add Sound...): Assigns the custom audio effect triggered when a character walks/steps on this surface, as well as the impact sound played when shooting at it.

7. VPX:

VPX Effect: Attaches a continuous particle or visual effect file (.vpx) directly to the selected object.

Physic Sounds
World Panel (Scene Collection) Displays a hierarchical list of all objects, actors, lights, and elements currently present in the 3D scene. Search Bar: Allows searching and filtering scene objects by name. Add Folder / Collection Button (+): Clicking the plus icon creates a new folder/collection. You can drag and drop scene elements into it to keep your scene organized. Selection & Deletion: Select: Left-click any element in the list to highlight and select it both in the tree and in the 3D viewport. Delete: Press the Delete key on your keyboard to permanently remove the selected element from the scene.

Sun & Dynamic Sky System Controls directional sunlight, dynamic day-night cycles, ambient lighting, and sky atmosphere. Viewport Interaction (Mouse & Gizmo): You can click and select the Sun actor directly in the 3D viewport. Using the 3D rotation gizmo (rings) or dragging with the mouse, you can manually rotate and aim the sun’s angle to dynamically change shadow directions and the sun’s position in the sky. Sun Properties (Details Panel - Right): 1. LIGHT: Intensity: Sets the primary sun brightness during the day (e.g., 1.10). Night Intensity: Sets the minimum light brightness at night (moonlight) so the scene doesn't turn completely black (e.g., 0.06). 2. COLOR: Light Color: The main direct light color emitted by the sun (e.g., warm white #FFF7EB). Horizon Color: The atmospheric color tint near the horizon line (e.g., #FF802E). Sunset Color: The sunlight color during dusk and sunset transitions (e.g., #FF4C0F). 3. AMBIENT: Controls indirect ambient fill lighting (shadow darkness and overall environment bounce light): Day Ambient: The fill lighting tone used during daytime. Sunset Ambient: The fill lighting tone used during sunset/dusk. Night Ambient: The fill lighting tone used during nighttime. 4. TIME OF DAY: Controls the real-time procedural day/night cycle clock: Time (0-24): Current hour of the day in a 24-hour format (e.g., 16.22 = ~4:13 PM). Dragging this slider dynamically transitions between day, sunset, and night. Speed (h/sec): The day-night cycle progression speed (in in-game hours per real second). Orbit Tilt: The celestial inclination/tilt angle of the sun's trajectory path across the sky (e.g., 60.7°).

Helox Engine - Main Toolbar

Save (Floppy Disk Icon): Saves the current project and level changes. Select Mode: Opens the available selection, placement, and editing modes. Cloud (Skybox): Controls the sky environment using 360° panoramic / skybox images to customize the sky appearance. Fog: Controls distance fog settings, atmospheric density, and depth appearance. Play (▶): Starts the real-time simulation/gameplay to test the project. Stop (■): Stops the running gameplay simulation and returns to edit mode. More Options (...): Opens additional project settings and quick editor controls.


. Basic Shapes:

A collection of foundational 3D geometric primitives used for level prototyping, greyboxing, and basic geometry layout:

Triangle: Spawns a 3D triangular prism/mesh.

Cube: Spawns a standard cubic box (used for floors, walls, and platforms).

Sphere: Spawns a 3D spherical mesh.

Cylinder: Spawns a cylindrical mesh (ideal for pillars, poles, and pipes).

Cone: Spawns a conical 3D shape (used for spikes, markers, or specialized geometry).

2. Lighting:

Submenu for creating scene light sources, ground bounce illumination, and volumetric atmospheric effects:

Point Light: Spawns an omni-directional light source that emits light evenly in all directions from a single point (ideal for lamps, light bulbs, torches, and explosions).

Ground Lighting: Spawns/configures ground-level ambient lighting and upward surface bounce light to illuminate characters and objects from below.

Volumetric Settings: Opens the volumetric lighting properties to configure atmospheric light shafts, god rays, and foggy light scatterin

3. Tools:

Audio: Spawns specialized audio emitters into the 3D scene:

Ambient: Plays background atmospheric sounds or environmental noise loops (e.g., wind, rain, room tone).

Touch: Triggers a sound effect when the player collides with or physically touches a specific trigger volume.

Bullet: Spawns sound emitters tied to bullet flybys, whizz-bys, or projectile pass-through zones.

Music: Places background soundtrack and interactive music zone triggers.

Box Collision Submenu:

Provides specialized cubic collision, trigger volumes, and AI navigation boundaries for level design:

Box Collision: Spawns a standard invisible collision box used as a physical barrier to block players/objects or trigger overlap events.

Box Merge: A volume used to merge or combine adjacent collision boundaries into a single unified collision space for performance optimization.

Box AI Collision: A dedicated collision volume that specifically blocks or affects AI/enemy movement while allowing the player to pass through freely (or vice versa).

Box Nav: Spawns an AI Navigation Mesh bounds volume (NavMesh) defining the walkable, computable 3D space for AI pathfinding.

Nav Patrol: Places an AI patrol volume or waypoint route used to set movement paths and patrol behaviors for enemies in the area.

Door Submenu:

Spawns interactive door actors with predefined opening and closing animation mechanics:

Normal Door: Spawns a standard hinged/swinging door that rotates open and closed along a side pivot axis (like typical room doors).

Up Door: Spawns a vertically opening door that lifts or slides upwards (ideal for garage doors, security shutters, gates, and industrial blast doors).

Sliding Door: Spawns a horizontal sliding door that slides open to the side (such as elevator doors, automatic sliding glass doors, or sci-fi sliding portals).

Level Submenu:

Exit:

Spawns an interactive level exit portal / trigger frame. When the player enters this frame, it loads and transitions the player to a designated target level configured in its properties.

Level Building:

Spawns the interactive level building wireframe into the scene (similar to UE5 blockout tools), allowing you to position the frame, customize block dimensions, and build 3D structures directly by pressing E.

HP Heal & Player Capsule Submenu:

HP Heal:

Spawns collectible health pickups and medkits into the scene to restore the player character's health points (HP):

Small: Spawns a small health pickup providing a minor health replenishment.

Medium: Spawns a standard/medium medkit providing moderate health recovery.

Large: Spawns a large health pack that provides substantial or maximum health restoration.

Player Capsule:

Spawns the player character's primary collision capsule and starting spawn location into the level, defining the player's physical footprint and entry point in the scene.

Cloud (Skybox): Clicking this button allows you to load and assign a 360° panoramic / equirectangular sky image (Skybox) that completely wraps around the entire 3D scene, providing a realistic background environment and sky appearance. (Note: Right-click the button to clear and remove the current skybox image).

Heolx Engine – Main Menu Bar 

1
1. File The File menu contains project and level management options: New Project: Create a new project. Open Project: Open an existing project. Add Level: Add a new level to the current project. Exit: Close the engine.
2
Edit The Edit menu provides editing and object management commands: Undo: Undo the last action. Copy: Copy the selected object. Paste: Paste a copied object. Delete: Delete the selected object. Play Game: Run the game.
3
Tools The Tools menu provides additional systems for creating and customizing your game: Sound: Add and manage audio in your scene, including ambient sounds, weapon firing sounds, and interaction sounds triggered when touching objects. Blueprints: Create and manage animation blueprints for characters, including players and enemies. VFX Effects: Add and control visual effects in your scene, such as explosions, particles, and other visual effects. UI: Customize the game's user interface, including menus, buttons, and screen layouts.
4
Object Settings The Object Settings menu contains the options that control the player and the health pickups: 1. Player Customization: Opens the player settings window. Play Options: Health, Speed, Jump Height, Stamina, and God Mode. Player Sounds: hurt, death, jump, land, step, and melee hit. 2. Health Properties: Opens the health pickups window. Set the HP amount and an optional 3D model for the Small, Medium, and Large pickups (default HP: 15 / 20 / 100). To place a pickup in the scene, use Tools > HP Heal > Small / Medium / Large.

Sound System

1. Ambient: Add environmental sounds, such as flowing water. When moving away from the sound source, the volume gradually decreases.

2. Touch: Add a sound that plays when touching a specific frame or object.

3. Bullet: Add a sound effect or voice commentary that plays when the player shoots at something.

Player Customization Window

. PLAY OPTIONS (Character Attributes & Physics):

Health: Sets the player's total maximum health points (e.g., 100).

Speed (m/s): The movement and running speed of the player in meters per second (e.g., 7).

Jump Height (m): The vertical jump peak/height achievable by the player in meters (e.g., 1.28).

Stamina: Sets the total stamina/endurance pool used for sprinting, dodging, or jumping (e.g., 100).

2. PLAYER SOUNDS (Audio Triggers):

(Each sound slot includes a ▶ Play button to preview audio and a Browse button to load audio files).

Hurt sound: Audio triggered when the player takes damage or gets hit.

Death sound: Audio played upon player death or zero health.

Jump sound: Sound effect emitted when initiating a jump.

Land sound: Impact audio triggered when the player lands back on the ground after falling or jumping.

Step sound: Footstep audio loop played during walking and running.

Melee hit sound: Sound effect played when the player strikes or hits a target with a melee attack/kick.

Action Buttons:

Cancel: Discards all changes and closes the window.

Save: Confirms and applies the customized player stats and sounds to the project.


Health Pickups Configuration Window

Header Overview Cards:

Provides a quick visual summary of the healing output for each tier:

SMALL: Restores +15 HP.

MEDIUM: Restores +20 HP.

LARGE: Restores +100 HP

Tier Settings Breakdown (Small / Medium / Large Health):

1. SMALL HEALTH:

Heal amount (HP): The exact number of health points restored when the player collects this pickup (e.g., 15).

Model: Assigns the 3D mesh file (.fbx / .obj) representing the small health kit in the world (Browse to select, ✕ to clear).

Texture: Assigns the texture image applied to the 3D model (Browse to select, ✕ to clear).

2. MEDIUM HEALTH:

Heal amount (HP): The health points restored upon collection (e.g., 20).

Model: Assigns the 3D model for the medium medkit.

Texture: Assigns the texture image for the medium medkit model.

3. LARGE HEALTH:

Heal amount (HP): The health points restored upon collection (e.g., 100).

Model & Texture: Assigns the 3D mesh and texture map for the large health pack.

Action Buttons:

Cancel: Discards any modifications and closes the window.

Save: Confirms and applies the custom values, models, and textures to all health pickups in the project.


VPX EFFECTS Editor Window

Top Toolbar: Save (Floppy Disk Icon): Saves the current VFX package, graph structure, and parameter configurations. Images: Batch-imports one or multiple image textures at once, automatically generating linked sequential nodes in the graph. Playback Controls (▶ Play / ■ Stop): Starts or stops real-time effect playback across both viewports. SETTINGS (Dropdown): Opens global VFX project preferences, canvas color space (RGBA 8bpc), and export configurations. 2. Explorer (VFX) Panel (Left): Manages the project's visual effect packages and categories. + Add Button: Creates a new VFX package or emitter layer. Project VFX Packages List: Displays all created effect presets (e.g., VPX) for quick switching and editing. 3. VPX Graph (Center Canvas): The visual node-based workspace where visual effect sequences are arranged and linked. Sequential Nodes (e.g., 1 MuzzleFlash, 2 Muzzleflash..., 3 Particle): Each node represents a single animation frame or sprite layer. Connection Pins & Wires: Connects the output of one frame to the input of the next, establishing the flipbook playback order. Active Node Highlight: The currently selected node is highlighted with a blue border, loading its individual settings into the Parameters panel. 4. Parameters Panel (Right): Controls rendering attributes, coloration, transform scale, and animation timing for the effect: Color: Tint: Hex color code and visual color picker (e.g., #FFFFFF) to tint the effect. Quick Palette Swatches: Preset color buttons for instant tint selection (White, Yellow, Orange, Red, Purple, Cyan, Green). Intensity: Multiplies the brightness/glow strength of the particle (e.g., 1.00). Appearance: Opacity: Sets the overall transparency level from 0.00 (invisible) to 1.00 (fully opaque). Scale: Multiplies the overall scale of the effect (e.g., 1.05). Size (m): Defines the physical size of the effect in world meters (e.g., 0.35 m). Rotation: Sets the base rotation angle in degrees (e.g., 0°). Blend Mode: Alpha: Standard alpha transparency blending. Additive: Adds pixel colors together, producing bright glowing and fiery illumination. Playback: Speed: Playback rate multiplier (e.g., 1.00 for normal speed). Fade In / Fade Out: Adds smooth opacity ramping at the start or end of the effect. Duration Info: Displays total playback time and frame count (e.g., 0.25 s (3 frames)). Reset to defaults: Restores all parameter sliders to default factory values. Specific Parameters: Opacity Override: Fine-tunes opacity specifically for the currently selected node in the graph. 5. Preview Viewports (Bottom): 2D Viewport (Left): Frame & Texture Counter: Displays the active frame index and file name (e.g., 1 / 3 MuzzleFlash.png). FPS (Frames Per Second): Sets playback speed for the 2D sequence (e.g., 12 FPS). Loop Checkbox: Automatically loops the 2D flipbook animation continuously. Checkerboard Display: Shows the isolated sprite animation with an alpha channel grid. 3D Viewport (Right): Model / Projectile Selector (e.g., Explosive ▼): Selects which weapon or projectile 3D model to attach the effect to. 3D Preview Area: Visualizes how the effect looks in real-time 3D space when spawned on a flying projectile, gun barrel, or surface impact.

Part 1: UI Designer (Base Canvas & General UI)

1. Left Panel (Palette & Hierarchy): Palette Tab: Contains standard UI widgets ready to be added to the canvas: Button: Interactive clickable button. Text: Text label for titles and dialogue. Image: Visual image or texture display container. Panel: Background container for grouping and nesting child elements. Hierarchy Tab: Displays the structural tree order and parent-child nesting of all widgets on the screen. 2. Center Canvas (Workspace): Canvas Resolution (1280 x 720): Virtual screen space with grid guides for alignment. Canvas Navigation: Right-Click: Quick context menu to add Text/Image or edit. Right-Drag: Pans across the canvas. Ctrl + Mouse Wheel: Zooms in and out. Zoom Controls (Fit / 100% / Reset Pan): Adjusts canvas zoom scale and recenters the view 3. Bottom Bar (Mode Switcher & Global Save): Editor Modes: Switches between UI Designer, Menu, and HUD editors. Save / Auto-Save: Manual save button with an automatic auto-save background toggle and time tracker. 4. Right Panel (DETAILS): Widget: Displays the name and class type of the selected widget. Layout: Sets pixel coordinates and size (X, Y, Width, Height). Appearance: Modifies label text, text color, font size, alignment (left/center/right), and widget background color. Font: Selects typography font families and font style (Bold). Border: Adjusts border line color, thickness, and rounded corner radius. Image: Selects the 2D image file and stretching/scaling mode. Delete Widget: Removes the selected element from the canvas.

Part 2: Menu Editor (In-Game Menu Customization)

English Documentation Menu Header Title (Title (engine name)): Controls the primary title text displayed at the top of the menu (e.g., HOZEX ENGINE): Text: The title string displayed on screen. Font & Size: Customizes title font family and point size (e.g., 34). Color: Hex color code and color swatch picker for the title text. Background Settings: Choose image / video...: Allows loading a custom static image or background video loop behind the menu. Remove background: Clears the active background asset. Dim: Slider and tint picker to darken/fade the background for text readability. Loading Screen Settings: Text & Bar Color: Customizes the loading text (e.g., Loading...) and loading progress bar color. Choose loading image...: Assigns a custom background splash art for loading screens. Reset loading screen: Reverts loading screen assets to defaults. Menu Buttons List (RESUME, RESTART, SAVE, OPTIONS, QUIT): Modify button label strings directly. Assign custom icon graphics to each individual button. ✕ Button: Clears or hides unneeded menu actions. Reset to default: Restores default menu button layout.


Part 3: HUD Editor (In-Game Heads-Up Display)

1. Live HUD Interactive Preview (Center): A real-time workspace displaying all active on-screen gameplay widgets. You can directly click and drag any element to change its location: Health Display (100+): Bottom-left player health counter. Crosshair (+): Center-screen aiming reticle. Weapon Silhouette (? Box): Active weapon illustration box. Ammo Counter (30 / 90 with bullet icon ?): Bottom-right current magazine and reserve ammo counter. 2. Add Elements Panel (Right): + Text: Adds custom HUD text elements (e.g., objectives, timer, armor). + Image...: Imports custom HUD graphics, icons, or UI status indicators. Remove health + icon: Toggles visibility or removes the default health counter. 3. Selected Element Positioning: Click any element in the preview canvas to drag it freely. X / Y Coordinates: Fine-tunes the exact horizontal and vertical pixel position of the selected HUD widget. 4. Reset Positions: Restores all HUD widgets (health, ammo, crosshair, icons) back to their default screen anchor positions. (Note: All layout coordinates are saved directly to hud_layout.ini).


Blueprint Interaction System

Labels Panel (Left):

Responsible for adding and managing weapon type classifications based on whether they belong to the player or enemies.

Add (+): Adds a new weapon type label (such as Shooter, Melee, Explosives, etc.).

Player / Enemy: Toggles between the player and enemy lists to categorize and manage weapons for each.

Labels List: Displays the created weapon types to select and customize their parameters in the settings panel.

2. Viewport / 3D Scene (Center):

The main 3D workspace for real-time visualization and angle adjustment.

Main Scene (3D View): Visualizes the character's collision capsule and 3D grid to test weapon placement and scale.

Camera (Camera Icon): Adjusts, switches, and aligns the camera angles and preview perspectives.

3. Settings Panel (Right):

Houses all editable parameters, meshes, ammo counts, decals, and visual effects for the selected weapon.

Weapons: Sets weapon type, imports the 3D weapon model (FBX), assigns materials, and configures sockets (Muzzle, Shell).

Ammo Box: Configures the ammo pickup model, materials, and bullet count.

Magazine Drop: Toggles magazine ejection physics and sets the drop delay time.

Bullet: Assigns the projectile mesh, material, and ballistic settings.

Impact Decal: Manages bullet hole decals, surface impact textures, and shrapnel visual effects.

Player 
Enemy

WEAPONS Section (Weapon Configuration)

WEAPONS Section (Weapon Configuration)

Responsible for importing the weapon model, assigning materials, managing multiple weapon meshes, and setting up sockets for firing and effects.

Weapon Type:

Displays the weapon's assigned category and ownership (e.g., Player · Shooter).

Weapon Model (FBX....) & Add Weapon (+ Add Weapon...):

Imports the 3D weapon model (FBX file) to represent and render the weapon inside the 3D scene.

Material:

Assigns and customizes the textures, shaders, and surface material applied to the weapon mesh.

Weapons:

Displays the registered name and identifier of the currently loaded weapon (e.g., persuadersmg).

Add SK (Skeletal Mesh):

Allows adding multiple skeletal mesh weapons so you can switch between them. (Note: Only one weapon can be active and displayed in the 3D viewport at a time).

Attached To:

Displays the character bone or parent socket that the weapon is currently mounted to.

Sockets (Muzzle / Shell / ...):

Configures orientation and spawn points for visual effects:

Muzzle: Adjusts the position and angle/direction of the muzzle flash and projectile spawn.

Shell: Defines the shell casing ejection point and trajectory.

(Note: Idle states / character reference must be defined first for this option to become active and accurately positioned).

Sockets Count:

Indicates the total number of active sockets created on the weapon.

Saved In:

Displays the absolute project file path where this weapon’s configuration and assets are stored.

MAGAZINE DROP Section

Controls the physical ejection and visual behavior of the weapon's magazine (clip) during the reload sequence.

Magazine Drop (Off / On Toggle):

Enables or disables the magazine drop mechanic. Must be switched to On for the magazine ejection feature and its related settings to be active.

Drop Time (sec):

Specifies the precise time (in seconds) during the reload animation at which the magazine detaches and drops from the weapon (e.g., 0.8 seconds).

Select FBX... (Magazine Mesh):

Imports and assigns the 3D model file (.fbx) representing the ejected magazine.

Material:

Assigns and customizes the texture, color, and surface material applied to the dropped magazine mesh.

Reset (Undo Button):

Reverts the magazine asset and material slots back to their default empty states.


1. IMPACT DECAL Section

Controls the 2D visual decal/mark projected onto surfaces (walls, floors, objects) at the point of bullet impact.

Impact Decal Selector:

Allows selecting an existing decal preset or using the built-in system texture (defaults to Default (built-in)).

Select Image...:

Opens a file browser to import a custom 2D texture/image file for the bullet hole or surface impact mark.

Impact Decal Image (File Path):

Displays the file path of the currently assigned impact decal texture within the project assets.

Reset (Undo Button):

Reverts the decal image back to the system's Default (built-in) preset.

2. HUD ICONS Section

Manages the 2D graphical icons displayed on the player's on-screen interface (HUD / UI) for this specific weapon.

Ammo Icon:

Select Image...: Assigns a 2D image/icon representing the weapon's bullet or ammunition type in the player's HUD counter.

Ammo Icon (File Path): Displays the file directory path of the selected ammo icon.

Weapon Icon:

Select Image...: Assigns a 2D image/icon (silhouette or illustration) representing the weapon on the HUD, inventory, or weapon-selection wheel.

Weapon Icon (File Path): Displays the file directory path of the selected weapon icon.

Reset (Undo Buttons):

Clears the assigned icon and resets the slot back to empty (—).

1. MUZZLE EFFECT Section

Controls the particle and visual effects (VFX) produced at the weapon's muzzle/barrel upon firing (Muzzle Flash).

Muzzle Effect (Off / On Toggle):

Enables or disables the muzzle flash visual effect when shooting.

Effect Scale:

Controls the size and scale multiplier of the particle effect (default is 1).

Select VPX... (VPX Effect):

Opens the file browser to import and assign a visual particle effect file (.vpx) for the muzzle flash.

Reset (Undo Button):

Clears the assigned VPX effect asset and resets the slot to empty (—).

2. FIRE SHAKE Section

Configures camera/screen shake dynamics triggered upon weapon discharge to deliver realistic firing recoil feedback.

Fire Shake (Off / On Toggle):

Toggles the camera screen shake effect on or off when the weapon is fired.

Intensity (0 - 5):

Sets the strength and violence of the camera shake on a scale from 0 (no shake) to 5 (maximum violent shake).

Duration (sec):

Defines how long the camera shake lasts in seconds before returning to normal (e.g., 0.12 seconds).

Saved In:

Displays the directory path where the fire shake configuration file (fire_shake.cfg) is saved.

TEXTURE Section

Controls the texture and material mapping for the character model (assigns the Player model texture when under the Player label, and the Enemy model texture when under the Enemy label).

Texture (Button: Texture...):

Opens the texture manager to assign and apply textures to the character's 3D mesh (Player or Enemy).

Textured Parts:

Displays the specific body parts or material slots of the character mesh that currently have textures applied.

2. WEAPON SETTINGS Section (AMMO & RELOAD)

Controls the ammunition economy, magazine limits, and reloading dynamics for the weapon.

Max Ammo:

The absolute maximum total ammunition capacity that can be carried for this weapon.

Mag Ammo:

Magazine capacity; defines the maximum number of bullets loaded inside a single magazine/clip.

Ammo Reserve:

The starting or backup ammunition stored in the reserve inventory (outside the currently loaded magazine).

Ammo In Box:

The amount of ammunition granted to the player upon picking up an ammo box item.

Ammo Per Shot:

The number of bullets consumed with each single shot (default is 1).

Reload Time (sec):

The total duration (in seconds) required to complete the reload action (e.g., 2.2 seconds).

Reload Speed:

The playback speed multiplier of the reload animation.

Shots Before Reload:

The number of shots permitted before forcing an automatic reload (set to 0 to rely strictly on Mag Ammo).


DAMAGE Section

Defines the damage output dealt to targets upon hit.

Damage:

The base health points subtracted from the target per hit (e.g., 1).

Random Damage:

A randomized value added to (or varied from) the base damage to simulate critical hits or damage variance (e.g., 0 for consistent damage).

2. FIRE Section

Governs the firing mechanics, projectile physics, and ballistics.

Fire Rate:

The firing speed / cadence of the weapon (higher values mean faster shooting).

Bullets number:

The number of projectiles spawned per trigger pull (e.g., 1 for rifles/pistols, or multiple for shotgun pellets).

Range:

The maximum effective flight or detection distance of the shot.

Projectile Speed:

The physical velocity of the flying projectile in world units (e.g., 512).

Projectile Collision Radius:

The size of the collision hitbox around the flying bullet, determining how easily it detects hits on targets (e.g., 8).

3. RECOIL Section

Controls camera and crosshair displacement caused by weapon kickback.

Recoil:

The base overall recoil magnitude.

Recoil Yaw:

Horizontal recoil; the amount of left-to-right crosshair deviation per shot (e.g., 0.35).

Max Recoil Pitch:

The maximum cap/limit for upward vertical recoil climb (e.g., 12 degrees).

Recoil Recovery Speed:

How fast the camera/crosshair returns to its original center point after shooting stops (e.g., 30).

Kick Per Shot:

The backward visual and physical kick applied to the weapon model with each shot (e.g., 0.6).

4. SPREAD Section

Controls bullet trajectory inaccuracy and crosshair bloom dynamics.

Spread:

The base bullet deviation angle when standing completely still (e.g., 0 for perfect precision).

Move Spread:

Additional spread penalty applied to accuracy while the character is moving (e.g., 1.5).

Spread Per Shot:

The amount of crosshair bloom added per continuous shot fired during automatic or rapid fire (e.g., 0.25).

Max Bloom:

The absolute maximum spread cone limit allowed during sustained fire (e.g., 3).

5. IMPACT DECALS Section

Manages the memory and rendering limits for surface bullet hole decals.

Decal Max Count:

The maximum number of bullet hole decals allowed to exist simultaneously in the game world before old decals are removed (e.g., 64).

ANIMATION STATES Panel (Current Type: Shooter) 

Manages all character animation clips and synchronized audio triggers. This panel is currently configured for the Shooter archetype, but dynamically adapts to other weapon types (e.g., Melee, Explosives).

Header Controls (Play / AI Toggle):

Switches the animation preview behavior in the viewport between standard playback/player controls and AI-driven behavior preview.

Standard State Controls (Available on each state card):

Preview State (Eye Icon): Selects and immediately displays the chosen animation state on the character inside the 3D viewport. For example, clicking the eye on the IDLE state will instantly render and loop the idle animation in the scene, allowing you to manually pick and preview whichever specific motion state you want to inspect.

Delete (Trash Icon): Clears the currently assigned animation asset from that state.

Play: Plays the assigned animation clip in real-time.

Audio: Assigns and triggers synchronized sound effects (SFX) tied to that motion (footsteps, cocking, impact sounds).

Animation Asset Slot (? Icon): Drag-and-drop or select the 3D animation clip to assign it to this state.

Animation States Breakdown (Shooter Archetype):

STATE: START

The initial weapon draw, equipping, or battle-ready transition animation.

STATE: IDLE

The resting breathing/holding loop played when the character is standing still.

STATE: WALK

The forward/directional walking movement animation with the weapon held.

STATE: RUN

The sprinting/running movement animation.

STATE: KICK

The melee physical attack animation (e.g., kicking enemies away during combat).

STATE: SHOOT

The firing animation, including weapon recoil kickback and character upper-body reaction.

STATE: RELOAD (Dual-Stage Reload System):

Manages weapon reloading animations based on the current magazine status:

[ 1 ] NORMAL (Tactical Reload): Played when reloading while bullets still remain in the magazine (ammo is not zero). This is a faster reload that replaces the magazine without racking the slide/bolt.

[ 2 ] EMPTY (Full Reload / Chambering): Played when the magazine is completely empty (ammo reaches zero). Requires a full reload sequence that includes inserting the magazine and cocking/chambering the weapon.


NIMATION STATES Panel (Current Type: Melee) 

STATE: START

The initial equipping or drawing animation for the melee weapon.

STATE: IDLE

The combat-ready idle stance while holding the melee weapon.

STATE: STRIKE (Multi-Hit Combo Attack System):

Manages weapon strikes with a progressive combo chain system that changes animations with consecutive button presses:

Combo Chain Slots [ 1 ] [ 2 ] [ 3 ] [ 4 ]:

Allows assigning up to 4 sequential attack animations. With each consecutive attack input, the character advances to the next animation (e.g., Strike 1 ➔ Strike 2 ➔ Strike 3 ➔ Strike 4 / Finisher), allowing you to create fluid multi-hit combos.

Combo Window / Reset Time (0.8 s):

Defines the timing window in seconds. If the player presses the attack button within this time, the next combo attack triggers; if the time expires, the combo resets back to 1.

Slot Eye Icons:

Instantly previews that specific combo step (1, 2, 3, or 4) on the character in the 3D viewport.

STATE: KICK (Multi-Kick Combo System):

Manages physical kick attacks using the same combo mechanics:

Kick Chain Slots [ 1 ] [ 2 ] [ 3 ] [ 4 ]:

Allows chaining up to 4 consecutive kicking animations with each press (e.g., Light Kick ➔ Side Kick ➔ Spin Kick).

Timing Window (0.8 s):

The time limit to execute the next kick before the combo sequence resets.

ANIMATION STATES Panel (Current Type: Explosive)

STATE: START: Weapon draw and equip animation for the explosive weapon.

STATE: IDLE: Idle breathing and ready stance while holding the explosive weapon.

STATE: WALK: Forward walking animation with the weapon equipped.

STATE: RUN: Sprinting and running animation with the heavy weapon.

STATE: KICK: Melee kick attack to push nearby enemies away from the blast radius.

STATE: SHOOT: Projectile launch / firing animation and recoil reaction.

STATE: RELOAD:

[ 1 ] NORMAL: Tactical reload played when ammo is not zero (fast reload without cocking).

[ 2 ] EMPTY: Full reload played when ammo reaches zero (requires loading and chambering/cocking).

EXPLOSIVE Section

Configures the explosive ordnance properties and 3D visual models.

Explosive Type (Projectile / Grenade):

Selects the delivery method for the explosive:

Projectile: Used for launched or rocket-propelled explosives (e.g., RPG rockets, missiles).

Grenade: Used for hand-thrown or lobbed explosive ordnance.

Select FBX... (Projectile / Grenade Model):

Imports and assigns the 3D model file (.fbx) representing the physical projectile or grenade mesh that appears when firing or throwing.

Material:

Assigns and customizes the texture, shader, and surface material for the explosive model.

Reset (Undo Button):

Clears the assigned 3D model and material, resetting the slot back to empty (—).

STATE: PULL PIN

The animation of pulling the safety pin from the grenade to prime/arm it before throwing (includes the hand motion and the pin-release sound trigger).

STATE: THROW

The physical throwing animation where the character lobs or hurls the grenade forward toward the target.

Animation Timeline Panel

Playback Controls: Jump to Start (|◀): Moves the playhead to the very first frame (Frame 0). Step Backward (◀): Moves backward by one single frame. Play / Pause (▶): Starts or pauses the real-time animation playback. Step Forward (▶): Advances forward by one single frame. Jump to End (▶|): Moves the playhead to the final frame of the animation. Frame Counter (Frame 0 / 232): Current Frame (0): Displays and allows jumping to a specific active frame number. Total Frames (232): Defines the overall length/duration of the animation in total frames. FPS (30): Frames Per Second; controls the playback speed and frame rate calculation for the animation. Loop: Enables continuous looping so the animation automatically restarts upon reaching the final frame. History Tools (Undo / Redo): Undo: Reverts the last keyframe or timeline modification. Redo: Reapplies the previously undone action. Keyframe Tools: Add Key (◆ Add Key): Inserts a new animation keyframe at the current playhead position. Delete Key: Removes the selected keyframe(s) from the timeline. Fit: Scales and adjusts the timeline view horizontally to fit all frames within the visible window.

Keyframe Selection & Trimming (Timeline)

Multi-Frame Selection (Shift + Left-Click Drag):

Hold down the Shift key while clicking and dragging the left mouse button across the timeline to create a selection box. This allows you to highlight and select a range of multiple keyframes simultaneously (indicated by the blue selection highlight).

Trimming & Batch Deletion:

Once a range of frames is selected, press the Delete key on your keyboard (or click the Delete Key button) to remove unwanted frames, allowing you to easily trim the animation and keep only the exact motion frames you need.

Undo Recovery (Ctrl + Z):

Instantly restores and recovers any keyframes that were deleted by mistake.

Repositioning Keyframes & Adjusting Duration (Timeline)

This workflow ensures your trimmed animation starts immediately and loops smoothly without unwanted pauses.

Moving Selected Frames to the Start (Shift + Drag to Frame 0):

After trimming unwanted frames, select the remaining keyframe block (using Shift + Left-Click) and drag it all the way to the beginning of the timeline (Frame 0), as shown in the second image. This removes any initial delay before the animation starts playing.

Adjusting Total Frame Count (Preventing Animation Freeze):

Reduce the total frames value in the frame counter (e.g., changing from 232 down to 42, as shown in the third image) to match the exact end of your remaining keyframes.

Why this is important: Leaving extra empty frames causes the character to freeze/hang on the last pose until the playhead finishes the timeline. Matching the total frame count ensures a seamless, fluid loop without freezing.

Important Note:

Each animation state (such as IDLE, WALK, SHOOT, etc.) has its own completely independent timeline and dedicated frame configuration. You can customize, trim, and set the frame count for each state individually according to your needs without affecting the other states.

Locating Saved Weapon Assets (Content Browser Navigation)

Once you create, configure, and save a weapon label, it is automatically organized and stored within the project's internal directory structure based on its category and ownership.

Asset Directory Path Hierarchy:

Content ➔ Control ➔ Elements ➔ Labels ➔ [Player / Enemy] ➔ [Weapon Type] ➔ [Weapon Asset File]

Step-by-Step Navigation:

Elements Folder: Navigate to Content > Control > Elements and open the Labels folder.

Character Category: Select either the Player or Enemy folder depending on who the weapon was created for.

Weapon Type Subfolder: Open the folder corresponding to the weapon’s combat type:

Shooter: Contains firearms, pistols, and automatic weapons.

Melee: Contains close-combat weapons (swords, knives, bludgeons).

Explosive: Contains launchers, rockets, and grenades.

Weapon Asset File: Inside the subfolder, you will find your generated weapon preset file (e.g., persuadersmg), complete with its custom thumbnail and saved parameters, ready to be reused, referenced, or inspected.

Browser Navigation Bar:

Back / Forward (< / >): Navigates between previously visited folder directories.

Breadcrumbs Bar (Home > Content > ...): Displays your current folder level and allows instant one-click jumping back to parent directories.


Script System

Tag

A Tag is a label you give to an object, such as Player or Enemy, so scripts can tell what kind of object it is. New objects start as Untagged.

Setting a Tag

Select an object in the scene.

Click the Tag dropdown at the top of the Inspector, next to World.

Pick a tag from the list. The current tag shows a check mark.

Add Tag

Click Add Tag... at the bottom of the list to create your own tag, such as Coin or Door. New tags appear in the list for every object. Tags are saved with the object in the scene.

Add a Script

Add a Script In the Content Drawer, right-click on an empty area. A Create menu will appear. Click Add Script. A window will appear asking for the script name. Enter a name and confirm. The new .lua file is created in the Content Drawer and opens in the script editor. You can also double-click any existing .lua file in the Content Drawer to open it.

Script Editor 

Script Editor The script editor opens in its own tab next to your level tab. It has two main areas. Code Area This is where you write your Lua code. File tab: Shows the name of the open script. You can open several scripts, each in its own tab. Line numbers: Shown on the left side, so errors are easy to find. Cursor position: The current line and column appear at the top right (for example, Ln 25, Col 3). Syntax colors: Keywords, comments, strings, and numbers are shown in different colors to make the code easier to read. Problems Panel This panel sits below the code area. It lists any errors in your script, including the file name and line number. When the script has no errors, it shows “No problems detected”.

Script Editor The script editor opens in its own tab next to your level tab. It has two main areas. Code Area This is where you write your Lua code. File tab: Shows the name of the open script. You can open several scripts, each in its own tab. Line numbers: Shown on the left side, so errors are easy to find. Cursor position: The current line and column appear at the top right (for example, Ln 25, Col 3). Syntax colors: Keywords, comments, strings, and numbers are shown in different colors to make the code easier to read. Problems Panel This panel sits below the code area. It lists any errors in your script, including the file name and line number. When the script has no errors, it shows “No problems detected”.
Script Options in the Inspector Once a script is attached, it appears in the Script section with its own options. The variables you declare in your script show up here, so you can change them without editing the code. Script Row Checkbox: Turns the script on or off. Name: The attached script’s file name. Trash button: Removes the script from the object. Edit: Opens the script in the script editor. Options Each global variable becomes an option under the script row. Variable names are shown with spaces, so flySpeed appears as Fly Speed. Number: Type a value, such as Fly Speed or Walk Speed. Checkbox: For true/false values, such as Can Fly and God Mode. Text: For values like keys, such as Fly Toggle Key. Changing Options Change any value and it works right away. You can also change values while the game is running and see the result live. Values are saved with the object, so each object can have its own settings. Variables declared with local, or starting with _, are hidden from this list.

Export Settings Window

1. Game - General (Image 3):

Defines core executable metadata and the destination path for the exported build:

Game Name: The official title of the game and the name of the generated executable file (.exe).

Version: The release build version number (e.g., 1.0.0).

Output Folder: Specifies the target folder directory on your drive where the compiled game files will be saved (Browse to select a folder).

2. Game - Maps (Image 2):

Configures level inclusion and initial game startup flow:

Description: Chooses which level the game starts from upon launching.

Start Level (Dropdown): Selects the primary default map/stage (e.g., NewLevel_01) that automatically loads when the player launches the exported executable.

3. Game - Splash Screen (Image 1):

Configures the introduction screen and developer credits displayed when the game launches before the main menu loads:

Note: Leaving the logo and name fields empty skips the splash screen entirely.

Studio Name: Input field to enter your game studio or team name (e.g., My Studio).

Developer: Input field to credit the lead developer or development team.

Studio Logo: Assigns a 2D logo image (.png / .jpg) centered on the startup screen (Browse to select).

Duration (seconds): Sets how long (in seconds) the splash screen stays on screen before transitioning to the game (e.g., 3 seconds).

Action Buttons (Bottom Right):

Cancel: Discards all changes and closes the export window.

Export: Begins packaging and compiling the game into a standalone playable application.

© 2026 Helox Engine. All rights reserved.
Nexior Game — Helox Engine Studio