Intersect Engine

The AvatarController requires a specific directory hierarchy to locate avatar assets. The assets directory must be a sibling to the server's standard logs and resources directories. The editor-specific resources must reside within assets/editor/resources.

server_root/
├── assets/
│   └── editor/
│       └── resources/
│           ├── entities/
│           └── faces/
├── logs/
└── resources/

Intersect Engine supports migrations across three primary logical contexts and two database providers.

Supported Contexts

• Game: Uses Game and GameContext in code.
• Logging: Uses Logging and LoggingContext in code.
• Player: Uses Player and PlayerContext in code.

Supported Database Providers

• MySQL: Referred to as MySql in code (includes MariaDB).
• SQLite: Referred to as Sqlite in code.

When integrating with Intersect Engine, be aware of what constitutes a breaking change:

Breaking changes include:

• Altering or removing field signatures.
• Altering or removing property signatures.
• Altering or removing method signatures.
• Altering or removing class signatures.
• Altering or deleting assemblies.

Breaking changes do NOT include:

• Introducing overloads.
• Introducing new signatures (though these are still restricted in the main branch).

Migrations in Intersect Engine are organized by Context (the logical domain) and Provider (the database engine).

Supported Contexts

When specifying the --context flag, use the following roots:

• Game: Game or GameContext
• Logging: Logging or LoggingContext
• Player: Player or PlayerContext

Supported Database Providers

• MySQL: Identified by MySql in code.
• SQLite: Identified by Sqlite in code.

Intersect Engine uses a semantic versioning pattern: <major>.<minor>.<patch>.<build>.

For all versions below 1.0, the engine follows the specific pattern: 0.<major>.<minor>.<build>.

The project uses different branches to manage stability and feature sets. Note that branch definitions change after the 0.7.0-beta release.

Current Branching Model

Post 0.7.0-beta Branching Model

To manage database migrations in Intersect Engine, you must install the dotnet-ef tool.

Installation Command:

dotnet tool install --global dotnet-ef --version 7.*

Notes for Unix-like systems: If you encounter a zsh: no matches found: 7.* error, escape the asterisk:

dotnet tool install --global dotnet-ef --version 7.\*

Updating the tool: If you receive warnings that your tools version is older than the runtime, update them using:

dotnet tool update --global dotnet-ef --version 7.0.13

(Or use 7.* on Unix-like systems).

The Intersect client will not run from a debugger unless assets are present in the assets/development/client directory.

You should add assets (such as those from Intersect-Assets) to this location.

Recommended Workflow: Create a symbolic link from your custom resources repository (or a clone of the main_full branch of Intersect-Assets) to assets/development/client/resources to facilitate development.

When generating migrations within the Intersect.Server.Core project, you must adhere to specific command patterns to avoid known dotnet ef bugs and ensure correct file generation.

Critical Requirements

1. Always include --startup-project ../Intersect.Server/. Do not omit this.
2. Always include --namespace and --output-dir. Omitting these may prevent the correct generation of *ModelSnapshot.cs files due to an existing dotnet ef bug.

General Command Pattern

dotnet ef migrations add <migration name> --context <provider><context full> --namespace Intersect.Server.Migrations.<provider>.<context root> --output-dir Migrations/<provider>/<context root>/ -- --databaseType <provider> [--connectionString "..."]