rayengine-cli
Project scaffolding and Cargo tools for rayengine games. The installed binary
is named rayengine.
Use --kind 3d for a first-person starter, or new-plugin to create a plugin
library. Starters depend on the matching published SDK version by default.
For engine development, supply --sdk-path /path/to/rayengine/crates/rayengine.
The CLI also supports info, build, and --json structured responses.
Rust 1.89 or later is required. The CLI itself has no native graphics dependency; compiling or running games requires the SDK's Linux build/runtime prerequisites. See the quickstart and CLI contract. Licensed under MIT.
Games generated by rayengine new include an optional rayengine.toml describing
assets, runtime defaults and named profiles. Cargo.toml remains the Rust build
manifest. info, check, build and run accept a project directory or either
manifest path. Use --profile NAME to select a project profile; this is separate
from Cargo's --release. run --bin NAME overrides project.executable.
Info results include resolved paths, defaulted settings and available profiles.
Check/build/run validate every profile before invoking Cargo. Optional manifest
absence preserves the existing workflow; invalid manifests produce an
invalid_project_manifest JSON error. Generated runtimes consume the explicit
manifest/profile passed by CLI run, or load their source project's manifest
when run directly with Cargo. Existing games opt in through the shared loader.
See the SDK's project manifest guide
for schema, merge rules, Rust/CLI precedence, asset selection and extension tables.
The rest of a game's lifecycle is available through templates, package
(bundle alias), add/remove, watch, and clean:
topdown and platformer starters use tilemaps and core collision physics.
Use a repository SDK until those matching first-party plugins are published.
Plugin dependencies match the SDK version or infer local repository paths;
add --plugin-path selects a compatible local crate. Hooks remain game-owned.
watch --json emits one completion result after Ctrl-C or a --cycles /
--timeout-ms bound. package builds a release binary, relocates assets/fonts,
preserves license notices and produces a Linux folder plus tarball under
bundles/. Extract and run ./launch; runtime libraries are documented in the
bundle's README and runtime-libraries.txt. Build on your oldest supported Linux
baseline. Clean preserves unrelated output files; repeat --output for custom
bundle locations. Doctor hints only print commands and never run them.