This tutorial (tutorial-3) is specific to PlantUML. If you prefer draw.io, check out tutorial-4.

Let's try it quick!

With the goal of keeping things as simple as possible to start, this tutorial uses PlantUML as the diagram tool, but StateSmith also supports draw.io (covered in other tutorials). PlantUML is a great place to start.

The first design we will look at is a small Hierarchical State Machine (HSM) that represents the state of Mario in a game.

As you complete the lessons in this tutorial, you'll be able to interact with the generated state machines in your web browser.

One of the later lessons will be programming language specific (C, C++, C#, JavaScript, Java, Python).

Download This Tutorial

You should download the full contents of this tutorial to your computer so that you can follow along with the examples and complete the exercises.

Use this link to download the tutorial or click the green "Code" button at the top of the Github page and select "Download ZIP".

Then unzip the contents to a location on your computer where you can easily access them.

Download or Install the StateSmith CLI

There are two main ways to run the StateSmith CLI:

1. Download the pre-built binary for your computer (no need for dotnet, no need to install anything).
2. Install the StateSmith CLI using the dotnet SDK.

Follow the instructions here for the method that you prefer.

Quick Test of the StateSmith CLI

Let's test the StateSmith CLI to make sure it is working. Run the following command in your terminal:

ss.cli --version

You should see output similar to the following:

Using settings directory: /home/afk/.config/StateSmith.Cli
StateSmith.Cli 0.14.0+4a4e30018e9a371124530fa96cf2ba3322b80459

Make sure the version is at least 0.11.0. I generally recommend using the latest version available.

We will cover the most important commands in this tutorial, but if you are curious, you can find additional usage information here.

Onwards! ⏭️

Navigate to lesson-1 and see the readme there.