Get Started
Welcome! Here you'll find everything you need to get started making games with Mirror Engine.
We're glad you're building with us!
Invite-Only Alpha
We're in our early releases of Mirror Engine, thus will be some bugs and rough edges, but we're working hard to improve the experience for you. Thank you for bearing with us.
Need an alpha key? Apply here.
Guides vs. Scripting
On the left sidebar, each section has a Scripting sub-section with API references for the relevant classes and methods.
Some sections of the docs will only have Scripting references; this is because we're still working on its implementation. We're spending many late nights to ship these features to you!
Step 1: Make a Game
Click "Make a Game" on the sidebar.
For the alpha, we encourage you to simply build a game.
Why? Our goal is that you never need to read this how-to guide. Our aim is that the UX is intuitive enough to where you can hit the ground running with ease.
If our UX is ever mediocre or confusing, please let us know.
Publish in The Mirror
"The Mirror" is our platform: you make games with Mirror Engine and publish them in The Mirror. When a game is published, it runs in Play Mode. Any account on Mirror Engine can play any game, available on Windows, Mac, Linux, and Chrome.
We'll take this even further: Any asset, any entity, any game, and any world will all be interoperable with other games, assets, and entities in The Mirror.
We'll provide more info on the publishing process soon in future releases.
Videos
Check out Jared's YouTube channel for tutorials and the latest updates.
Info Buttons
Look for these buttons as you're building to guide you. Also, click the "Quick Request" button on one to xeet us on X with a request.
Versioning
Similar to Chrome, we regularly increment a major version each release (e.g. V2, V3, V4, etc.), which can be as infrequently as monthly and as frequently as multiple times a day.
V2 was our first alpha release. We consider Mirror Classic our V1, so the major version counter increases from V2 onward.
Does a major version mean breaking?
Nope. Our aim is to maintain backwards compatibility as much as possible.
Nevertheless, we'll inevitably need to deprecate some scripting APIs in the future. We'll give you ample notice to make it as smooth as possible. The ideal scenario, of course, is that you never need to make any changes at all.
Community
Join our Discord for more help and to hang out with players and developers.