Skip to content

rqio.json Reference

This content is for v0.2.1. Switch to the latest version for up-to-date documentation.

The rqio.json file describes metadata, entry points, dependencies, build settings, and automation scripts for RayQuiro packages and applications.


{
"name": "my-game",
"version": "1.0.0",
"description": "2D arcade game built with RayQuiro Engine",
"author": "Raytolfas <[email protected]>",
"license": "MIT",
"entry": "main.rq",
"build": {
"output": "bin/game",
"release": true,
"target": "windows-x64"
},
"dependencies": {
"telebot": "^2.1.0",
"username/math-lib": "v1.0.0"
},
"devDependencies": {
"rq-test": "^0.5.0"
},
"scripts": {
"start": "rqio run main.rq",
"build": "rqio build main.rq --release",
"build:linux": "rqio build main.rq --release --target linux-x64 -o bin/game_linux",
"test": "rqio run tests/test_all.rq"
}
}

FieldTypeRequiredDescription
namestringYesUnique package name. Lowercase alphanumeric with - or _.
versionstringYesSemantic version string: MAJOR.MINOR.PATCH (e.g. 1.0.0).
descriptionstringNoShort human-readable summary of the package.
entrystringYesMain script file executed upon import (defaults to main.rq or index.rq).
authorstringNoAuthor name and contact information.
licensestringNoOpen-source license (e.g. MIT, Apache-2.0, GPL-3.0).

Specifies packages required at runtime:

"dependencies": {
"my-lib": "^1.2.0",
"username/custom-tool": "v2.0.1"
}
  • "^1.2.0": Compatible semantic version (same major version).
  • "v1.0.0": Exact Git tag match.

Configures default compilation settings for rqio build:

KeyTypeDescription
outputstringDefault output binary path.
releasebooleanActivates -O3 LLVM optimization passes.
targetstringTarget triple: linux-x64, windows-x64, macos-arm64.
noLLVMbooleanFallback to GCC compiler if true.

Project tasks runnable via rqio run <script>:

"scripts": {
"dev": "rqio run main.rq",
"build:prod": "rqio build main.rq --release -o bin/app.exe"
}