CSharpPluginTemplate

A minimal source-compiled C# plugin for the Hosihikari framework. The C# loader compiles main.cs at load with Roslyn and runs it in a collectible ALC; there is no build step for the author.

Use it

1. Keep this repository outside the server. Rename the plugin: change manifest.json name, rename MyCSharpPlugin.conf, and rename the class in main.cs. The package directory name must equal the manifest name.

2. Pack it with the framework packer. It restores #:package and copies the included source:

   pwsh ./pack.ps1

   bash ./pack.sh

   The packer needs a sibling PluginManager checkout, or HOSIHIKARI_PLUGINMANAGER pointing at one.

3. Copy dist/MyCSharpPlugin/ to <server>/plugins/MyCSharpPlugin/.

4. Install the shim variant for the server and the C# loader:

   lip install github.com/HosihikariFramework/HostingShim#levilamina   # or #endstone
   lip install github.com/HosihikariFramework/CSharpLoader

5. Restart the server. The log shows the plugin loading and enabling.

For the self-hosted Linux carrier, install the suffix-less shim package and start the server through hosihikari-server; loaders and plugins still live under plugins/.

Files

• manifest.json — loader: csharp, depends on hosihikari and hosihikari-csharp.
• main.cs — a public parameterless type implementing IPlugin. It also demonstrates two file-based directives: #:package System.IO.Hashing@10.0.13 and #:include parts/helper.cs.
• parts/helper.cs — compiled with main.cs through #:include.
• pack.ps1 / pack.sh — run the framework packer; dist/MyCSharpPlugin/ is the installable package.
• MyCSharpPlugin.conf — package defaults.

The packer restores #:package at pack time and copies the included source; the server does not download packages when it loads the plugin. #:include paths are relative to the including file and may use globs such as ../shared/*.cs.

Configuration and data

• Package defaults: plugins/<name>/<name>.conf.
• Server override: config/hosihikari/<name>.conf.
• Environment variables override the same keys.
• Runtime data: data/hosihikari/<name>/.

Lifecycle

OnLoad runs after dependencies are ready. OnEnable opens the event/timer gate; a refusal keeps the plugin loaded and disabled. OnUnload releases what the plugin owns. An exception from a hook is a fault and the host unloads the plugin.

See the authoring guide for the full contract.

Licence

MIT-0, see LICENSE.md.