Riftlang tooling in 5 minutes
Starting a project
Section titled “Starting a project”You can start a project two ways:
- In Rift Forge:
Project Manager->New Project - Using the Rift CLI:
rift init
Project structure
Section titled “Project structure”my-game/ project.forge
scripts/ game-loop.rift scenes/ players/ ui/ underlays/ world_maps/ plugins/project.forge: the project’s settings.scripts/: your Riftlang scripts and libraries.scripts/game-loop.rift: game cycle configuration, what systems run in what order?scenes/…world_maps/: game contentplugins/: the game plugins imported into the project.
Config files
Section titled “Config files”project.forge is your project settings.
name = "my-game"
[plugins]enabled = [ "rift.ui.default", "rift.movement.click", "rift.music"]
[run]main_scene = "scenes/overworld.scene"
[rift]version = "0.1.5"name: the project’s name.[plugins] enabled: the game plugins this game uses.[run] main_scene: where players first spawn[rift] version: the Rift runtime that runs the game.
User Interfaces
Section titled “User Interfaces”UI is written in ts2, as .ts2 files in ui/. Forge compiles them and utilitises a code generator to produce Riftlang code so you can easily write type safe full-stack game code.
import rift.ts2.UI
on_ui_component_click(UI.Logout.button) { subject -> subject.message("See you soon.")}Compiling with the rift CLI
Section titled “Compiling with the rift CLI”The Rift runtime comes packaged with a CLI: rift. It helps you to start, build and run Rift projects. rift also manages runtime versions, it’s a version manager similar to nvm or mise.
rift check: dry-run variant ofbuild, check for errors.rift build: compiles the game, ready to be run.rift dev: runs the project for development. Every save goes live.rift run: runs the builtgame.jarfor production.rift hooks: lists the engine’s hooks, one line each.rift runtime: lists, installs, pins and removes runtimes.rift runtime which .: names the current projects runtime version
Writing Riftlang in your IDE
Section titled “Writing Riftlang in your IDE”Riftlang is natively supported in the Rift Forge script editor, but if you prefer to write your code elsewhere we provide support for the following IDEs through the Riftlang language server.
IntelliJ IDEA and other JetBrains IDEs, 2025.2.1 or newer
Section titled “IntelliJ IDEA and other JetBrains IDEs, 2025.2.1 or newer”Install the Riftlang plugin to get real-time hints, syntax highlighting, intellisense, code completion and go-to-definition.
Link: TBA
Visual Studio Code
Section titled “Visual Studio Code”Install the Riftlang extension get real-time hints, syntax highlighting, intellisense, code completion and go-to-definition.
Link: TBA