Dependencies

.Net SDK 9.0 is required for development.

Currently, it's also required on player machine. That's temporary limitation, self-contained distribution will be supported soon.

Download

• Windows
• macOS
  • Binaries are not signed, so it requires to allow it running on your Mac in macOS settings.
• Linux
• Install from sources

How to use

Install .NET 9.0 SDK if it's not installed yet.

Select a project directory where you'll keep scripts and other resources.

Run editor:

• (All OS) Specify project directory via command line argument C:/dev/fyrox_cs_sdk/fyroxed_cs_netcore.exe <path>
• (Windows only) Double-click on C:/dev/fyrox_cs_sdk/fyroxed_cs_netcore.exe icon and choose project directory in opened dialog window.
• (Windows only) Drop project directory on the C:/dev/fyrox_cs_sdk/fyroxed_cs_netcore.exe icon in file explorer.

Minimal C# project files will be created automatically and C# project will be automatically compiled.

Game can be launched using Play button in editor. Also, game can be launched using IDE with debug support (run profile for JB Rider generated, for other IDE note that working directory should be the project directory, not the build directory). Also, game can be launched using dotnet run in the game directory.

Scripts

Inherit classes from NodeScript to create scripts that can be attached to scene nodes in editor via dropdown on Inspector panel at the right.

Inherit from GlobalScript to create singleton scripts (no need for [Uuid(...)] attribute).

NodeScript classes should be annotatee using [Uuid(...)] attribute. Consider JB Rider plugin for Fyrox C# - it generates UUID, but also puts attribute if script created via context menu, also it highlight fields. If you use different IDE, UUID value using any online service like this.

Look into guards_cs project as an example.

Scripts Reloading

Editor reloads scripts metadata automatically after their compilation. In-game hot reload is not supported.

Scenes & Assets

Original Fyrox engine is 100% relevant in all non-code things, so Fyrox Book is advised for non-code information.

• Fyrox Book: Editor Overview
• Fyrox Book: Assets

CLI

The fyroxed_cs_netcore.exe can also be invoked via terminal with project path argument.

Install from sources

That's optional, because prebuilt binaries are available.

1. Install .NET 9.0 SDK if it's not installed yet.
2. Install latest Rust toolchain.
3. (Windows only) Install Git Bash. Other MSYS2 distribution haven't tested.
4. Checkout sources and install using shell command (use Git Bash on windows)

   git clone https://github.com/kkolyan/fyrox_lite.git \
     && cd fyrox_lite \
     && chmod +x **/*.sh \
     && ./bash/cs_install_sdk.sh <installation path>
   

<installation path> now contains ready-to-use binaries.