Introduction

Kinemium is a sandbox engine written in Luau (Zune Runtime). It includes a custom scripting language called Kilang, with Luau-style syntax and additional features.

Notice

Kinemium is an independent project not affiliated with, endorsed by, or connected to Roblox Corporation. Roblox is a trademark of Roblox Corporation

Features

Datatypes

• Axes
• BoundingBox
• BrickColor
• CFrame
• Color3
• Color4
• ColorSequence
• ColorSequenceKeypoint
• CustomPhysicalProperties
• NumberSequence
• NumberSequenceKeypoint
• Random
• Ray
• Region
• Spring
• UDim
• UDim2
• Vector2
• Vector3
• Enum
• Faces / NormalId
• Rect / Region3
• And a whole lot more..

Default Services

• Debris
• GuiSelectionService
• HttpService
• Lighting
• LogService
• Players
• ReplicatedStorage
• RunService
• Selection
• ServerScriptService
• ServerStorage
• StarterGui
• TweenService
• UserInputService
• Workspace

Kinemium Custom Services

(All custom services start with Kinemium.)

• KinemiumFFIService
• KinemiumFontService
• KinemiumIconLoader
• KinemiumModService
• KinemiumPhysicsService
• KinemiumRaylib
• KinemiumShaderService

That's cool.. But how do I use this?

Fortunately theres a tutorial:

• Clone the repo: git clone --depth 1 https://github.com/Qquaded/Kinemium-Engine.git

• Get zune (skip this step if you have it already installed.)
  https://zune.sh/guides/install

• Run the engine
  zune run engine
  This tutorial works with both Linux and Windows, MacOS support is coming soon.

Commands

Kinemium provides with several flags you can run with zune run game

• headless (lets you run the engine without graphics)
  
• server (lets you run a server version of the engine, this is used for games and such)
  
• client (lets you run a client, it removes all the core UI only)
  
• kilang (lets you run kilang code in the terminal, you can add this flag with any other flag and it will still work)
  
• editor (enables studio UI)

Multiplayer

Kinemium provides multiplayer support with the server and client flags:

Making a server with an address and port:
zune run game --server --address 0.0.0.0 --port 1234 --auth_token your_token

Connecting a client:
zune run game --client --address server_ip --port 1234 --auth_token your_token

You can also just do --server and --client without any arguments and it will run on localhost.

Running live on localhost:
zune run game --server
Connect a client:
zune run game --client

Editor

Kinemium has a built-in editor GUI that lets you playtest, script, build, and edit objects.

Enabling Editor mode:
zune run game --editor
Running server with editor mode
zune run game --server --editor

Examples

example command with a flag:
zune run game --client
zune run game --client --kilang
zune run game --server --kilang
zune run game --headless

Preview

How do I add scripts?

Once you clone the github repo, you will find a folder called sandboxed inside the engine (src)
There are a set of predefined scripts in there as examples, but you can change any of them.

Can I make my games have modding support?

Yes! there is a modding service called KinemiumModService (said up there)
This lets you add mods to your game, and you can set the enviroment of your said mods!

How do I spell Kinemium?

Ki-nem-yum!!

This project uses

• Raylib
• Manifold
• Box2D
• Jolt Physics
• Discord RPC
• Steam SDK
• Sail
• Webview
• Native File Dialog (NFD)
• raylib-gizmo
• Python (runtime)
• QuickJS (runtime)
• Webview
• Luau
• and most importantly.. Zune kv1.10.4

Do you like cats?