Guide to running Kinemium Engine

Tutorials
1

Hello, this is a guide on how to install the engine (and run it of course!)

  1. Open Terminal
  2. Install git if you haven’t installed it already (run git --version): Git - Install
  3. Clone the engine in your designated folder: git clone https://github.com/Qquaded/Kinemium-Engine.git
  4. Install Rokit if you haven’t already (run rokit --version): GitHub - rojo-rbx/rokit: Next-generation toolchain manager for Roblox projects · GitHub
  5. CD (cd ./Kinemium-Engine) into the engine and install Zune: rokit install
  6. Run the engine! zune run engine

Or, you could download from the releases page: Releases · Qquaded/Kinemium-Engine · GitHub

How to update the engine

  1. Run this command: zune run updater
  2. Choose branch of your choice (nightly for latest, main for stable)
  3. Done!

If you have any issues, please report the issue at the Bug reports category.

How to run a server

Running a kinemium server is very easy, you can just do zune run engine --server
And if you want it headless: zune run engine --server --headless

How to run a client

Running a client is basically like the server, but with more flags, you get to decide each flag’s value:
zune run game --client --username YOURUSERNAME --port 1234 --address 127.0.0.1
You can also just skip the port and address, and it will try to connect to localhost:
zune run game --client --username YOURUSERNAME
Not inputting username will make the engine default to the name environment variable in your computer.

How to run Docker, and make an Image

  1. CD into the engine:
    cd ./Kinemium-Engine

  2. Build an image:
    docker build -t kinemium-engine .
    This may take some time.

  3. After your done with that, Lets run the new image!
    docker run kinemium-engine

How to make a script

You can make a new script in the sandboxed folder in the engine

image
image1379×756 62.7 KB

There are example scripts that are on default commented, you can uncomment them and run the engine to see what they do, or learn from them.

Conclusion

Thank you for reading this! if you have any trouble with any of the steps written in this guide, make a post in the Bug reports category. Wish you a happy experience!

1 Like