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

Getting started

Transmute Core is a Java 17 engine for 2D pixel games. Start with a verified example: it includes assets, a Gradle wrapper, and a headless verification task.

Set up

Install Flox and Git, then:

git clone https://github.com/transmute-games/transmute-core.git
cd transmute-core
flox activate
./gradlew :transmute-core:publishToMavenLocal

Flox supplies the pinned Java and website toolchains. Without Flox, install JDK 17 and use the checked-in Gradle wrapper. Bun is only needed for repository and website checks.

Run an example

cd examples/java/hello
./gradlew test verifyHeadless
./gradlew run

The first command works without a display. The second opens the game window; it needs a desktop session. Copy examples/java/hello to start your own project, or choose platformer or RPG.

Use the CLI

Download transmute-cli.jar and the wrapper for your operating system from releases. Put both in a directory on your PATH, and make the Unix wrapper executable with chmod +x transmute.

transmute new my-game -t basic -y
cd my-game
./gradlew run

Available templates are basic, platformer, and rpg. The CLI requires Java 17. Generated games resolve the engine from Maven Local or JitPack; internet access is required on the first dependency download.

Make it yours

Diagram: Init[init: load assets] --> Update[update: game logic]; Update --> Render[render: draw pixels]; Render --> Update
Diagram source
flowchart LR
    Init[init: load assets] --> Update[update: game logic]
    Update --> Render[render: draw pixels]
    Render --> Update

Implement init(), update(Manager, double), and render(Manager, IRenderer) on a TransmuteCore subclass. Use Manager for assets, states, objects, and input. Put resources in src/main/resources/ and describe them in gamespec.properties.

Read game lifecycle for configuration and callbacks, then assets and headless testing.

Troubleshooting

  • Java not found: run flox activate, then java -version.
  • Dependency unavailable: publish the engine locally with the command above; the examples use mavenLocal().
  • No display: run verifyHeadless instead of run.
  • CLI not found: add the directory containing the wrapper to your PATH.
  • Missing resource: check the path and case under src/main/resources/; classpath paths do not start with that directory name.

Edit this page on GitHub