just_game_engine_cli library
The Just Game Engine's commands for just (just_core_cli), and the
release toolkit behind them.
On every platform, the web included (JavaScript and WebAssembly):
- GameSet: the engine's packages, at versions that work together, the Flutter and Dart they need, and a pubspec moved onto them (GameSet.bump).
- GameTemplate: a new game's files; GameEntries: where a game and its editor start.
- ReleaseRules, ReleaseImports and ReleaseBuild: proving that the editor never ships — what must not, the imports a source names (and ReleaseImportsUnchecked, a walk that could not look), and the check of a release build's files (ReleaseBuildFiles).
- FormatsCheck: the saved files' formats, and their migration.
Where dart:io is (Windows, macOS, Linux, Android, iOS), the
library also exports the commands — GameCommand:
just game run|build|check|scene|doctor|upgrade|migrate|mcp, and the
hooks just runs (game init when just create makes a game,
game link for just dev link|unlink) — MigrationSafety, and the
ProjectGame extension, which reads a game on disk for the checks:
releaseRules(), editorReachableFrom(entry),
checkReleaseBuild(platform), checkFormats(), editorIsOpen() (the
heartbeat the editor writes, read as just_game_engine_formats'
EditorHeartbeat says). The JustProject it extends (from
package:just_core_cli/project.dart) is exported with it.
The just_core_cli types these take and give are exported too: JustProjectFile, ProjectNames, ToolSet, SetPackage, PackageSource and Version.
Classes
- FormatFinding
- One file's format, as checked.
- FormatsCheck
-
The versioned files under
assets/: scenes, timelines, animator graphs, the tag library and the physics layers.JustProject.checkFormats()(theProjectGameextension, wheredart:iois) checks every one in a project on disk. - GameCommand
-
just game: run and build the game, check that a release holds no editor, manage its scenes, move the engine's packages and migrate its saved files, serve the engine to an AI assistant (game mcp) — plus the hooksjustruns:game init(whenjust createmakes a game),game check,game doctor,game upgrade,game migrateandgame link(just dev link). - GameEntries
-
Where a game starts, and where its editor does:
just.json'sentry.gameandentry.editor, else defaultGame and defaultEditor. - GameSet
-
The Just Game Engine's packages, at versions that work together, and the
Flutter and Dart they need: what
just game initstarts a game on, whatjust game doctorchecks it against, and whatjust game upgrade(theupgradehook ofjust upgrade) moves it to. - GameTemplate
-
The files of a new game, and what it changes in the files
flutter createmade. - JustProject
-
A Dart or Flutter project: the folder holding its
pubspec.yaml. - JustProjectFile
-
A project's
just.json. - MigrationSafety
- Guards rewriting old files with the engine's rules alone.
- ProjectNames
- What a new project is called, and how its files name it.
- ReleaseBuild
-
Checks a release build: the ground truth the import walk
(
ReleaseImports) stands in for. - ReleaseBuildFiles
-
A release build's files, as read: what ReleaseBuild.check judges.
JustProject.checkReleaseBuild(theProjectGameextension, wheredart:iois) reads them from a project'sbuild/folder. - ReleaseImports
-
What a Dart file imports, for the walk that proves no editor code is
reachable from a game's entry point: every
import,exportandpart, conditional imports' every branch too. A path that reaches a ReleaseRules.forbidden library, or the project's ownlib/editor/, would ship the editor. - ReleaseReport
- What a check of a build found.
- ReleaseRules
- What a project's release build must not hold, and how to recognise the game in one.
- SetPackage
- One package of a set.
- ToolSet
-
The tools
justkeeps a project on: just_core_cli itself, and the plugin of each kind of projectjust createmakes (kinds). - Version
-
A semantic version (semver 2.0):
1.2.3,1.2.3-dev.4,1.2.3+5.
Enums
- PackageSource
- Where a package in a set comes from.
Extensions
- ProjectGame on JustProject
- What the game's checks read from a project on disk: its release rules, the import walk from its entry point, its release builds, its saved formats, and whether the editor has it open.
Exceptions / Errors
- ReleaseImportsUnchecked
- The import walk could not look everywhere it had to, so it proves nothing: the entry point is not there, the project's packages were never fetched, or an import names a package pub did not resolve or a file that is not there.