transmute / core

The Transmute library

Find your next step.

Good places to start21 results
Getting startedInstall the engine and build your first game.GuidesArchitectureUnderstand the engine, managers, and game loop.GuidesExamplesStart with a working platformer, RPG, or hello world.GuidesHeadless testingVerify gameplay without opening a window.GuidesAPI overviewExplore the building blocks of the engine.APIGame lifecycleConfigure, initialize, update, and render your game.APIAssets and manifestsLoad sprites, fonts, and audio with GameSpec.APIWorlds and physicsBuild tile worlds, movement, and collision.APIHeadless harnessSimulate input and assert frames and audio.APIhello worldA hands-on walkthrough of hello world.Tutorialssprites and animationA hands-on walkthrough of sprites and animation.Tutorialsinput and movementA hands-on walkthrough of input and movement.Tutorialscollision detectionA hands-on walkthrough of collision detection.Tutorialsstate managementA hands-on walkthrough of state management.Tutorialsaudio systemA hands-on walkthrough of audio system.Tutorialslevel designA hands-on walkthrough of level design.TutorialsAuthoring gamesTurn a prompt and assets into a verified game.GuidesCookbookFind practical recipes for common game features.GuidesContributingSet up Flox and run the project checks.GuidesWebsite developmentDevelop, preview, and deploy this website.GuidesCLI distributionBuild and distribute the game scaffolding CLI.Guides
Your next game starts here.↑ ↓ Move ↵ Open esc Close
Browse documentation

CLI distribution

The engine and project generator have separate release histories. Engine tags use vX.Y.Z; CLI tags use cli-vX.Y.Z.

Automatic CLI releases

Every successful push CI run on master can create the next CLI patch tag. Auto-release first checks that the tested commit is still the branch head. It then dispatches release-cli.yml explicitly.

The release workflow checks out the tag, runs CLI tests, builds the fat JAR with -PreleaseVersion, and verifies that the executable reports that version. It uploads:

  • transmute-cli.jar
  • transmute and transmute.bat
  • LICENSE
  • SHA256SUMS

The JAR requires Java 17. Keep the wrapper beside the JAR in a directory on PATH. Download artifacts from GitHub releases.

Retry a release

Rerun the failed auto-release run, or dispatch an existing stable tag:

gh workflow run release-cli.yml --ref master -f tag=cli-v1.0.2

Use the tag that actually needs recovery. The workflow validates the cli-vX.Y.Z format, requires the tag to exist, and replaces assets when retried. It never moves an existing tag.

Engine releases

Engine releases remain deliberate. Update the root build.gradle version, test it, and tag the tested commit with vX.Y.Z. JitPack builds tagged engine artifacts on demand. Check the JitPack build before updating the CLI's ENGINE_VERSION in CliConstants.java.

For development, use:

./gradlew :transmute-core:publishToMavenLocal

See contributing for the complete CI and release flow.

Edit this page on GitHub