Quick Getting Started Guide.

Get pre-built binaries (Windows, Mac, Linux)

Latest version from CI

If you don’t want to deal with building it yourself, go to github CI (click on the latest succesful run to get a list of binaries). These are 64-bit for all platforms.

Now get https://github.com/aardappel/lobster (download zip). This has all the data files and examples. Place the binary you obtained in bin.

Releases

You can also get both from https://github.com/aardappel/lobster/releases (lobster_<date>_<platform>.zip and Source code (zip)), but these are usually way behind using the most recent builds above, so not recommended.

Or, build it yourself!

Linux

Pre-Requirements: Git, CMake, a C++17 compiler, Mesa dev files (apt-get install mesa-common-dev).

git clone https://github.com/aardappel/lobster.git
cd lobster/dev
cmake -DCMAKE_BUILD_TYPE=Release
make -j8
cd ..
bin/lobster samples/pythtree.lobster

Windows

Pre-Requirements: VS2019 Community edition or better, C++ desktop tools installed.

Get https://github.com/aardappel/lobster using your favorite git tool (best), or just download a .zip from there otherwise.

Open dev\lobster\lobster.sln, ensure Release is selected in the top bar, Build -> Build Solution, then close if no errors.

Mac

Pre-Requirements: Latest XCode.

Get https://github.com/aardappel/lobster using your favorite git tool (best), or just download a .zip otherwise.

Open dev/xcode/lobster/lobster.xcodeproj, ensure lobster_release > My Mac is selected as scheme in the top bar, Product -> Build, then close if no errors.

Running it

You now have a lobster executable in your bin folder. You can run this with any Lobster file as argument to run it, for example bin/lobster.exe samples/pythtree.lobster should work.

For more advanced usage, including how to run it from an editor, check the rest of the docs