Table of Contents

🚀 Getting Started

🛠️ Requirements

  • To start developing plugins for Onix Client, you will need the following tools and software. Each section below includes a link to the official download page and a tutorial to help you get set up.

💎 Onix Client Premium

🎮 Minecraft: Bedrock Edition

  • The game you will be modding so you need to have it installed.

💻 IDE (Integrated Development Environment)

To develop plugins for Onix Client, you will need an IDE to write and compile your code. I would personally recommend using Visual Studio or JetBrains Rider as they are both good IDEs, but it always comes down to personal preference. If your PC struggles to run either, then feel free to use Visual Studio Code, as it's lightweight and only needs a few extensions to work well with C#.

  • Note: JetBrains Rider's debugger does not work in this environment, you will have to use Visual Studio or Visual Studio Code for debugging.
  • Note: Make sure to install the C# extension for Visual Studio Code if you choose to use it.

🏢 Visual Studio

🦄 JetBrains Rider

  • Download JetBrains Rider here
  • A cross-platform C# IDE from JetBrains. Pretty good IDE, I personally use it. It has a lot of features and is very powerful.

📝 Visual Studio Code

  • Download Visual Studio Code (Tutorial here)
  • A lightweight, cross-platform code editor. Make sure to install the C# extension. I don't personally use it, but it's a good option if you have a low-end PC.

📥 Getting The Runtime Ready

  • Before you start developing or using plugins, you need to get the .NET runtime and the OnixRuntime placed correctly.
    • Thankfully, it's very easy to do! Simply run the following command in the game chat and wait for the setup to complete.
.plugin setup

This command will download everything you need to run a plugin. The correct OnixRuntime version will be automatically downloaded to match the client's desired version so you don't have to worry about it for the future.

🧩 Creating Your First Plugin

  • To get started with your first plugin, head over to the Creating Your First Plugin page. It will guide you through the process of creating a simple plugin and give you an overview of the Onix Client Plugin API.

🌐 Adding NuGet Source (Optional)

  • If you want the Onix Plugin NuGet packages, simply run dotnet nuget add source https://plugin-nuget.onixclient.com/ -n "Onix Plugins" in your terminal.
Edit this page