Skip to content
DreamWeave-MPPublic

About

An optimized Luau runtime for general-purpose programming and game engine development. Dedicated to those who didn't make it this far.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

jess

An optimized Luau runtime for general-purpose programming and game engine development.

Documentation: https://DreamWeave-MP.github.io/jess

Jess combines a small Rust kernel with a programmable Luau environment. Rust manages access to the operating system and hardware; Luau implements applications, tools, workflows, and policy. The kernel knows nothing about what runs on it, and that is the whole design.

Rust exposes reality. Luau decides what it means.

It ships as one binary, jess: the runtime, the test runner, the type checker, the package tool, the workspace tool, the type generator, and the style checker. There is no separate build system, package manager, or linter to install.

Jess is not a game engine. It is the environment you build one in, and the same environment builds command-line tools, servers, build pipelines, and the site that documents it.

Getting started

Release archives carry the binary for Linux, macOS, and Windows, signed with Sigstore. cargo install jess builds it from crates.io with Rust 1.95 or newer, given clang and lld on rustc's LLVM major and the linker flags the install page lists, or L3I_UNVERIFIED_TOOLCHAIN=1 for a build with whatever compiler you have. Then write a file:

--!strict
local name = ... or 'world'

print(`Hello, {name}.`)
$ jess run hello.jsl
Hello, world.
$ jess run hello.jsl Dave
Hello, Dave.

A shebang line makes it a program. #!/usr/bin/env jess at the top and chmod +x, and ./hello.jsl Dave runs it with every capability, as you'd expect of a program you chose to run. That is for scripts you trust; jess run is the default-deny form for code you're inspecting, and it names each thing the script reaches for.

Sources are .jsl files: Luau, checked under --!strict against types Jess generates for every module, so your editor knows the whole API before you've written a line. jess init sets a folder up with them, and jess check runs the same checker from the command line. Getting Started takes it from there.

Packages and applications

Luau software ships for Jess as a JPK: an immutable archive with a manifest naming its modules, what they export, what they depend on, the tests that ship with them, and the commands they provide. A source folder is the same package before packing, down to the digest, so what you test is what you ship. Several packages developed together form a workspace with a lock file, and a workspace packs into one file that runs anywhere jess does, or into one executable that runs where jess doesn't.

An application is packages loaded into one isolated runtime and driven by frames until it decides it is done. A game, an editor, and a server are all some packages, some callbacks, and a loop. Packages and Applications explain both.

What it gives you

  • Isolated execution. Script domains run separate programs in one process, each with its own lifetime and an explicit capability grant. Files, the environment, processes, and the network are denied until the operator grants them, and a package can never grant itself anything:

    $ jess run read.jsl
    error: dream.fs.readFileString: needs the 'filesystem.read' capability, which this runtime does not grant
    $ jess run --capability filesystem.read read.jsl
    
  • Extensible packages. Compose applications and tools from reusable Luau modules. A package is inert until a host activates it, and its tests, types, and style checks ship inside it.

  • A GPU and windows. Buffers, textures, pipelines, compute, and render graphs compiled into plans that draw every frame without entering Luau, presented to native windows whose keyboard and pointer feed the application's input. Shaders are written in Luau, typed and validated by jess, and lowered to WGSL. Vulkan, Metal, Direct3D 12, or OpenGL, whichever the machine has, found at run time.

  • Sound. A mixer on its own clock that never waits for a script: voices, buses, processors, feedback, modulation, sound placed in space, streams a worker fills while they play, and changes stamped to the sample they land on. It plays through the platform's output or renders offline into a buffer.

  • Game-engine foundations. An input action graph, and localization bundles in ICU MessageFormat. None of it is a game, and none of it decides what yours is.

A machine with no GPU, no display, or no sound still runs jess: it finds a software adapter or none, refuses a window when asked for one, and plays to a null device.

  • Native speed where it's earned. Luau runs on L3i, with native code generation for the modules that ask for it and profiling built into the binary. Nothing goes native without a measurement.

Architecture covers how the pieces fit.

Building from source

git clone https://github.com/DreamWeave-MP/jess
cd jess
cargo build --release

The binary lands at target/release/jess. Contributing covers the gates every change passes. Until 1.0, a minor version can break things: pin one.

How the project is run, who decides, and what it asks of you is GOVERNANCE.md, the Constitution of Jess. Its official venue is this repository's issues, pull requests, and discussions.

License

MIT OR Apache-2.0, at your option: MIT, Apache-2.0.

Dedication

Jess was inspired by the fierceness and independence of someone with whom I was very close in my youth. She taught me everything I know. I built Jess in order to preserve what little I have left of her.

Without her, S3kshun8 never would have been.

And hopefully, without Jess - your finest creations would never have been.

I hope this runtime brings you a fraction of the joy which she brought to my life. Spread the love, and hold the things you love tightly.

You never know when they'll be gone.

About

An optimized Luau runtime for general-purpose programming and game engine development. Dedicated to those who didn't make it this far.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages