Compilation Guide

1. Clone Repository with nested submodules

   git clone --recurse-submodules -j8 https://github.com/PixiEditor/PixiEditor.git

   or if cloned already, init submodules with

   cd PixiEditor

   git submodule update --init --recursive

2. Download Wasi-sdk release for your system

3. Extract downloaded sdk

4. Set WASI_SDK_PATH enviroment variable to extracted directory

5. Install wasi-experimental workload

   Tip

   You can skip this step if you only want to run PixiEditor.Desktop project

   Open terminal and run the following command:

   dotnet workload install wasi-experimental

6. Run PixiEditor.Desktop project

   This is how the repo structure looks like after cloning:

   • DirectoryPixiEditor

     • Directorysrc

       • PixiEditor.sln < — Source code solution file
       • DirectoryPixiEditor.Desktop

         • PixiEditor.Desktop.csproj < — run it to start PixiEditor
       • DirectoryPixiEditor

         • PixiEditor.csproj < — Main project, contains most of the code
     • Directorytests

       • PixiEditorTests.sln
     • Directorysamples

       • PixiEditorExtensionSamples.sln < — Solution containing sample extensions for PixiEditor
       • Sample1_HelloWorld.csproj
       • Sample2_LocalizationSample.csproj

   Either open PixiEditor/src/PixiEditor.sln in your IDE of choice or run the following command in terminal:

   Windows

   dotnet run --project src/PixiEditor.Desktop/PixiEditor.Desktop.csproj -r win-x64

   linux

   dotnet run --project src/PixiEditor.Desktop/PixiEditor.Desktop.csproj -r linux-x64

   macOS

   dotnet run --project src/PixiEditor.Desktop/PixiEditor.Desktop.csproj -r osx-arm64

   Replace osx-arm64 with osx-x64 if you are on Intel Mac.

   Make sure to run the commands above from root repo directory (the one contaning src folder)

Caution

If you build whole solution, you may encounter an error saying workload wasm-tools is not installed. You can ignore that error, since it only applies to PixiEditor.Browser project, which is not currently supported.

Known issues and solutions

Class X_Action not found

It means that code generators did not run correctly. This happens on .NET versions below 8.0.405. Ensure that you have .NET SDK 8.0.405 or higher installed.

Do not run PixiEditor with .NET 9, wasi-experimental workload is not compatible with .NET 9.

wasm-tools workload is not installed

This error can be ignored, since it only applies to PixiEditor.Browser project, which is not currently supported.