Skip to main content

Initial Setup

This page shows the basic configuration to have in order to test the code shown in the examples.

The server

You have to download the server, further details on the server page. You can download the file following this link:

Server download.

Create a package

A package is required to put the code stated in this pages. Detailed information about this can be found here
In short:

  • Open a Command Line where your server file is.
  • Input the following command: ./HELIXGameServer.exe --cli add package awesome-pkg
  • Press enter until you see the following message: Package 'my-awesome-package' has been created!
  • Close the CMD window.

Then the server folder will have the following files, double click on the Config.toml file to open it.

Setup the package

in order to test the code, a default map has to be added to the Config.toml file.
If config.toml is closed, open it and search for the following code:

# default startup map
map = ""

there, a blank map is going to be defined. That line of code should be changed to this:

# default startup map
map = "default-blank-map"

After adding default-blank-map save the file and close it.

Now the package is ready to allocate lua code and test it, just be careful to check if the LUA code has to be added on the client side or server side!



If a character is required to test, the following code can be added to the Server/Index.lua file:

-- Function to spawn a Character to a player
function SpawnCharacter(player)
-- Spawns a Character at position 0, 0, 0 with default's constructor parameters
local new_character = Character(Vector(1, 0, 100), Rotator(0, 0, 0), "helix::SK_Male")
new_character:AddSkeletalMeshAttached("head", "helix::SK_Male_Head")
-- Possess the new Character

-- Subscribes to an Event which is triggered when Players join the server (i.e. Spawn)
Player.Subscribe("Spawn", SpawnCharacter)

-- Iterates for all already connected players and give them a Character as well
-- This will make sure you also get a Character when you reload the package
Package.Subscribe("Load", function()
for k, player in pairs(Player.GetAll()) do


If a Weapon is required, then add the following code to Server/Index.lua file:

-- Spawns a Weapon
local new_weapon = Weapon(Vector(600, 0, 250), Rotator(0, 0, 0), "helix::SK_AK47")

---setup weapon
-- Configures how the Character Grabs and Aims the Weapon
new_weapon:SetSightTransform(Vector(0, 0, -1), Rotator(-1.5, 0, 0))
new_weapon:SetLeftHandTransform(Vector(22, 0, 9), Rotator(0, 60, 90))
new_weapon:SetRightHandOffset(Vector(-10, 0, 0))

-- Configures Weapon Particles

-- Configures Weapon Sounds

-- Configures Weapon Animations

Additional content

On the HELIX Repositories there are more advanced examples and Code, please visit the GitHub Repository