It's pretty easy to build on linux and has been tested with Debian/Ubuntu to work. This is the primary development platform used, and such tends to work the best.
Simply enter the Tools directory and run sudo bash Install-Linux.sh followed by bash Build.sh 4. The build command can be adjusted to fit the number of cpu cores that your system has by changing the argument. If you don't know how many CPU cores your system has, just leave the command as is. If something isn't working quite right for you, you can try cleaning the build with bash Clean.sh.
If some packages are missing on your distro, you'll have to substitute with whatever your distro uses. We try to include as many possible packages in our codebase as possible, but this isn't always possible or practical.
Since we don't develop on Windows, builds aren't guarenteed to work. With that said, they should work most of the time.
- Open Visual Stuido 2019 (Has to be this version)
- Install python 3.9.5 (needed to link with the interpreter, embeddable version already included in project tree, also restart your machine after installing to avoid issues)
- Clone the repository but note that you'll probably have to put it into a root level directory on your disk. This is because Microsoft has imposed a 260 character file name limit in their compiler.
- Open the CMakeLists.txt file, and generate the configuration
- Put your build config into debug/release based on what you're doing
- Set target to BrainGenix-ERS.exe
- Hit
Build
"[lmb]" - (When Hovering Gizmo) - Move Gizmo
"[left shift]" - (When Gizmo Active) - Move Camera While Moving Gizmo
"[s]" - Set Gizmo To Scale
"[g]" - Set Gizmo To Translate
"[r]" - Set Gizmo To Rotate
"[lmb]" - (When Not Hovering Gizmo) - Enter Camera Movement Mode (hold button)
"[lmb] + [w]" - Move Camera Forward
"[lmb] + [a]" - Move Camera Left
"[lmb] + [s]" - Move Camera Backward
"[lmb] + [d]" - Move Camera Right
"[lmb] + [left shift]" - Move Camera Down
"[lmb] + [space]" - Move Camera Up
"[lmb] + [scroll wheel]" - Adjust Camera Movement
"[`]" - Toggle Viewport Controls On/Off
The ERS scripting api uses the Python programming language to provide control over models, lights and more. Scripts can be "attached" to an object to allow for programatic control over it's attributes. Plese see the following API reference for more information.
"GameTime" - Number of seconds since the start of the game.
"SystemTime" - Unix epoch as reported by the system.
"ModelPosX" - X Position of the model
"ModelPosY" - Y Position of the model
"ModelPosZ" - Z Position of the model
"ModelRotX" - X Rotation of the model
"ModelRotY" - Y Rotation of the model
"ModelRotZ" - Z Rotation of the model
"ModelScaleX" - X Scale of the model
"ModelScaleY" - Y Scale of the model
"ModelScaleZ" - Z Scale of the model
"ModelEnabled" - Enable/Disable rendering of the model
"PointLightPosX" - X Position of the light
"PointLightPosY" - Y Position of the light
"PointLightPosZ" - Z Position of the light
"PointLightColorR" - Red component of Color(from scale of 0 to 1)
"PointLightColorG" - Green component of color (from scale of 0 to 1)
"PointLightColorB" - Blue component of color (from scale of 0 to 1)
"PointLightIntensity" - brighness of the light
"PointLightRolloffConstant" - Constant component of light rolloff (float)
"PointLightRolloffLinear" - Linear component of light rolloff (float)
"PointLightRolloffQuadratic" - Quadratic component of light rolloff (float)
"DirectionalLightPosX" - X Position of the light
"DirectionalLightPosY" - Y Position of the light
"DirectionalLightPosZ" - Z Position of the light
"DirectionalLightRotX" - X Rotation of the light
"DirectionalLightRotY" - Y Rotation of the light
"DirectionalLightRotZ" - Z Rotation of the light
"DirectionalLightIntensity" - brighness of the light
"DirectionalLightColorR" - Red component of color (from scale of 0 to 1)
"DirectionalLightColorG" - Green component of color (from scale of 0 to 1)
"DirectionalLightColorB" - Blue component of color (from scale of 0 to 1)
"SpotLightPosX" - X Position of the light
"SpotLightPosY" - Y Position of the light
"SpotLightPosZ" - Z Position of the light
"SpotLightRotX" - X Rotation of the light
"SpotLightRotY" - Y Rotation of the light
"SpotLightRotZ" - Z Rotation of the light
"SpotLightColorR" - Red component of color (from scale of 0 to 1)
"SpotLightColorG" - Green component of color (from scale of 0 to 1)
"SpotLightColorB" - Blue component of color (from scale of 0 to 1)
"SpotLightIntensity" - brighness of the light
"SpotLightCutoff" - Circular radius of spotlight inner lit area
"SpotlightOuterCutoff" - Outside area of spotlight cutoff