Install Ceramic

Ceramic window

Here you are, getting for the first time your hands dirty with Ceramic!

If you ended up here and don’t know what is Ceramic, you might want to read this introduction article first ➔ Discover Ceramic, a cross-platform and open-source 2D framework.

Install Haxe

Download and install latest Haxe.

Haxe download page

Haxe download page

Simply download and run the Haxe installer and follow the instructions.

The rest of the article assumes you are able to understand basic Haxe programming. If you are new to Haxe, you can take a look at the Haxe introduction and the many resources it provides from the Haxe Foundation.

Install Ceramic

A lot of things are done on the command line with Ceramic. We will enter command line instruction with the Terminal app on mac and linux, or with Powershell on windows. You need to be familiar with command line tools to continue.

The easiest way to install Ceramic is via haxelib. Open the terminal and type:

haxelib install ceramic

This should have installed a setup utility on your machine. You can now enter a second command to download the actual ceramic package and install it:

haxelib run ceramic setup

Follow the instructions, it will tell you where it wants to install Ceramic and do it (default behaviour is to create a ceramic folder in the current working directory where you are running your terminal. You can check more advanced install options on the haxelib page).

When it asks you if you want to make ceramic command available globally, you should choose yes so that the ceramic command will work by default on any command line session from any folder on your computer.

On Mac and Linux, depending on the permissions settings of your machine, you might need to run the setup with administrator rights: sudo haxelib run ceramic setup.

After the command has finished installing, you can check that Ceramic is working by typing:

ceramic

If you didn’t install ceramic globally, you can run it with haxelib run ceramic instead.

If you get a similar display as below, that means ceramic has been successfully installed 🎉.

Ceramic CLI

Installing Haxe (and haxelib) on your computer was required to follow this guide as we install Ceramic via haxelib, but note that Ceramic is mostly self-contained. It embeds its own versions of haxe, node & electron so that it won’t break if you update something on your computer. Projects generated by Ceramic contain their own local haxelib repository and are configured to use Ceramic’s embedded haxe for code completion and compilation.

Another note to Haxe developers using lix: Ceramic is not designed to work with lix. Creating a lix scope inside a Ceramic project is not supported. That said, a standard Ceramic project should work and compile fine even if your global haxe installation is running via lix, thanks to Ceramic being packed with everything it needs already.


Continue reading ➔ Your first Ceramic project