Framework/Core/FrameworkInfo.cs

Static constants file for the Roleplay Framework. Holds the framework name and semver, Lua API version, network protocol version, and a computed string for the Lua runtime name and version.

namespace RoleplayFramework.Core;

/// <summary>Version identity of the framework. Shown in diagnostics, the menu and (later) the server browser.</summary>
public static class FrameworkInfo
{
	public const string Name = "Roleplay Framework";

	/// <summary>Framework build version (semver).</summary>
	public const string Version = "0.1.0";

	/// <summary>
	/// Lua API compatibility version. Gamemodes declare the apiVersion they target; the loader rejects
	/// mismatches. Bump only on breaking changes to the Lua-facing API.
	/// </summary>
	public const int LuaApiVersion = 1;

	/// <summary>Network protocol version for framework messages (Hello / manifest / ready). Bump on wire changes.</summary>
	public const int ProtocolVersion = 4; // v4: addons (addon.json in the content manifest)

	public static string LuaRuntime => $"{Lua.LuaState.RuntimeName} {Lua.LuaState.RuntimeVersion} ({Lua.LuaState.LanguageVersion})";
}