Skip to content

Write a plugin in an hour

Ramjet plugins are plain C# class libraries (.NET 10) loaded into the running server. They compile against the Ramjet.Api NuGet package, subscribe to events, register commands, components and per-tick systems, and are hot reloaded every time you rebuild: no server restart, no lost state in the ECS.

If you have written Paper plugins you already know the shapes: a plugin class with enable/disable hooks, event listeners with priorities and cancellation, commands, permissions, a scheduler. The differences that matter are in how you write them, and they are explained in Concepts and in the migration table.

Step Time Page
1. Install the .NET 10 SDK and build the server 15 min Install
2. Create a project from the template 5 min Create a plugin
3. Understand the layout and plugin.json 5 min Project layout
4. Build, drop into plugins/, edit, watch it reload 10 min Build and hot reload
5. Write something real 25 min Your first plugin

Then read the five concept pages that carry the most weight: threading, entities and the ECS, events, hot reload and performance.

  • Concepts: how plugins work.
  • Guides: full, working code.
  • Examples: the sample plugins of the repository, with their source read at build time.
  • API reference: generated from the C# XML documentation.
  • For AI agents: llms.txt, llms-full.txt, api.json, a Claude Code skill and an AGENTS.md in the template.