Installing SymOntoClay

back to top

SymOntoClay is released under MIT License.

Please read the license before downloading and using!

SymOntoClay is developed and tested only on Windows 10.

In the future I am going to add another kinds of installers and support other platforms.

Installing CLI from source code

SymOntoClay CLI requires:

• NET 7.0

1. Clone SymOntoClay's repository to your computer.
   git clone https://github.com/Symontoclay/SymOntoClay.git

   You can also download source code archive from:

   • https://github.com/Symontoclay/SymOntoClay/releases
   • https://symontoclay.github.io/downloads/index.html
2. Cd to SymOntoClayCLI.
   cd SymOntoClay

   cd SymOntoClayCLI
3. Build SymOntoClayCLI
   dotnet publish --self-contained --runtime win-x64
4. Cd to directory with built result.
   cd bin/Debug/net5.0/win-x64/publish
5. Copy built files to target directory.
6. Add the target directory to the PATH system variable. Read the instruction here.

Installing CLI from archive

1. Download archive with built CLI to your computer.

   You can download this from:

   • https://github.com/Symontoclay/SymOntoClay/releases
   • https://symontoclay.github.io/downloads/index.html
2. Unpack downloaded archive to target directory.
3. Add the target directory to the PATH system variable. Read the instruction here.

Setting the PATH environment variable

For Windows 10 and Windows 8:

1. In Search, search for and then select: "System".
2. Click Advanced system settings.
3. Click Environment Variables.
4. In the section System Variables find the PATH environment variable and select it. Click Edit. If the PATH environment variable does not exist, click New.
5. In the Edit System Variable (or New System Variable) window, specify the value of the PATH environment variable. Please check: there should be semicolon (;) between added and exising paths in the PATH environment variable!
6. Click OK.
7. Close all remaining windows by clicking OK.
8. Restart your terminal and use SymOntoClay's CLI.

Installing components for Unity

SymOntoClay's components for Unity require:

• Unity 2022.2.8f1
• NET 7.0

SymOntoClay's components for Unity is supplied as custom unity package and hosted on Github. This is due to current project status as Proof of concept. In the future I am going to use Unity asset store.

SymOntoClay's components for Unity don't require installed CLI for run time. But CLI helps to create new projects on DSL.

1. Download components for Unity to your computer as .unitypackage.

   You can download this from:

   • https://github.com/Symontoclay/SymOntoClay/releases
   • https://symontoclay.github.io/downloads/index.html
2. Install downloaded package to your project using Unity's instructions.