Skip to content

discountdevs/Clarity

Repository files navigation

Clarity

Clarity (v2): The Modern, Moddable Platformer!

Ok, Ok. I know what you're thinking. You're thinking, "What happened to the old Clarity?", which is a fair question. I'll answer that quickly: After a game engine rework, Clarity (Legacy) is now an archived project and will not recieve any further updates. Clarity legacy can be found at: https://github.com/discountdevs/Clarity-Legacy

What is Clarity?

Clarity is a platformer game engine for the future. It allows for the simple creation of 2d platformer games using simple, high-level javascript in a format called a "mapvar".

Okay, but what is a mapvar?

A mapvar is a self-contained game. It contains textures, scripts, physics definitions, and much, much more. Mapvars can be published on the Workshop, and can then be played and reviewed by the community. The mapvar docs can be found here.

What happened to the workshop?

The old (now obsolete) workshop was unsecure and unstable. It has been rewritten, and it now contains none of the original levels. If you'd like to convert your old levels to the new format, you can use Legacy2Mapvar to convert them, either from the original level share code (commonly referred to as the "clipboard code") or from the level ID, if it was published to the workshop.

What about the development workflow?

If you wanna develop Clarity, fork the repo and clone it locally. Open it up in your favorite editor, and then open a terminal. If you're on windows, a tool is provided to spin up a server (requires python3 to be installed):

ezhost

Or, if you're on Linux, where python3 should be preinstalled:

python3 -m http.server

On mac, you can follow the same instructions as for Linux, just install Python through Homebrew first.

Make the changes you want to make, then push to your fork. Open a PR and provide a description of what you changed, and it will be reviewed and merged.

This page is still under construction

However, it is almost in a stable state that is ready for release. If you want to try it out, check the URL:

https://discountdevs.github.io/Clarity/

Join the discord: https://discord.gg/FbEJ2DyGME