Horizon2 is a LUA flight script for the game Dual Universe by Novaquark.
Originally developed by the ingame organisation 'Shadow Templars', the authors left the game but kindly
released the sources to the public in spring of 2024.
New maintainers on these repositories are working on updating the codebase to become compatible with the latest game version's LUA API.
❗ Horizon 2 is NOT a finished product, it was provided "as-is". It is NOT an elevator script!
- Codebase revised to fix deprecated DU API calls.
- Updated this README.md file.
- Updated links in .gitmodules file and referenced repositories.
- Renamed the original .gitlab file to .txt to avoid confusion.
- Added an interim "build_tobitege.bat" to run a build on the 2 main lua files (adapt paths to your env!).
- Added the "output" folder to the repository, which contains normal and minimized json files as of today.
- Status: script starts up without LUA errors, only basic HUD visible, mouse control active by default.
- Todo: need to identify what other HUD parts are not shown yet and make them visible.
The sections below detail various steps and methods when developing for Horizon2, along with the general style guides and principles when developing Lua code for Dual Universe.
Please take some time to familiarize yourself with the guidelines before beginning development.
Please visit the Horizon Support Discord server (original authors left Dual Universe, but maintainers may try to help): https://discord.gg/E2UEQhkzty
When developing DU Lua code, please observe the following guidelines:
If you are uncertain about the correct way to implement something, you should always consult a senior member of the research department.
If you do not already have VSCode installed, you can download it here. Once downloaded, install it and either open the folder (or if it exists the Horizon2.code-workspace workspace file) with VSCode.
To be able to build Horizon2 correctly, you need to clone the Horizon2 repository from the Horizon2 repository with below command in a terminal window:
git clone --recursive https://github.com/Otixa/horizon2/
This will create in the current folder a new "Horizon2" subfolder, including the repository and all its referenced sub-modules on your local drive.
Afterwards check, whether any of the following folders have content. If not, you need to clone the following libaries separately from their git into their respective directories within the Horizon2 folder onto your local drive:
- DUBuild ../horizon2/DUBuild
- DUnit ../horizon2/DUnit
- DataLib ../horizon2/Libs/Data
- SlotDetector ../horizon2/Libs/SlotDetector
- UtilityLibrary ../horizon2/Libs/Utils
- In order to build on save, you need to install the Trigger Task on Save extension.
- If you want to have IntelliSense support you should install Lua by sumneko.
- Additional recommended extensions are vscode-lua, Lua, and Lua Debug.
Once those are installed you can verify that the project builds correctly by opening, for example, Main_StandardBuild.lua and hitting ctrl+s or ctrl+shift+b. A terminal window should appear at the bottom of the IDE with the build progress.
The dubuild repository may have in folder DUBuild\Properties a launchSettings.json as an example.
Once the build finishes, it should have produced the following:
- JSON files for each of the main builds in the
./output/directory - Your clipboard will contain the
StandardBuildJSON - The
testresultsdirectory will contain the test results, provided the test run succeeded.
Here you will find some common issues when first attempting to start Horizon2 development, and ways to remedy them. There may be a PowerShell command file to start a build process like "build.ps1".
build.ps1 is not digitally signed. The script will not execute on the system.
If you get this error, run VSCode as Administrator and attempt to build. Subsequent runs without Administrator rights should not cause the error to reappear.
As a general rule, every changeset must be on its own branch. Generally, the branch would encompass one full feature or one issue.
Once you are satisfied with your changes, you push the branch to origin and create a merge request. You can do so by opening the repository in a web browser. A notification should appear at the top prompting you to create a merge request for the branch you just pushed.
❗ Never push directly to the
masterordevelopmentbranches
If you are unsure about how to do something - ask an AI or a senior developer for advice.
This system requires to implement a structural template with a fixed name and following below rules, so that the "dubuild" application can work on it. Please find and explore the examples in the dubuild repository!
This attribute should be the first one applied in a file. It designates which logical class is contained within the file for DUBuild to properly assemble its dependency tree.
It does not need to be an actual LUA class object, though, and can just include methods. The attribute "marks" this file like a bookmark so it can be referenced during the build process.
The --@class attribute should be followed by the class name.
Example usage:
--@class MyClass
function MyClass()
--- ...
endThis attribute should be applied to classes that depend on other classes/utilities.
The --@require attribute should be followed by a single class name. If you require multiple classes, you should include multiple --@require attributes.
Example usage:
--@class MyClass
--@require MyOtherClass
--@require YetAnotherClass
function MyClass()
--- ...
end