Quick Start

This guide will help you get started with writing Pumpkin server plugins using C.

Prerequisites

Before you start, ensure you have the following installed:

• wasi-sdk (for compiling C to WASI)
• git (to clone the API)

Setting up the project

First, clone the Pumpkin C API repository with submodules:

git clone --recursive https://github.com/Pumpkin-MC/pumpkin-api-c.git
cd pumpkin-api-c

Creating your first plugin

Create a file named main.c in the root of the repository and add the following content:

#include "pumpkin_api.h"
#include <stdio.h>

pumpkin_metadata_t get_meta(void) {
    static const char* authors[] = {"you"};
    return (pumpkin_metadata_t) {
        .name = "my-c-plugin",
        .version = "0.1.0",
        .authors = authors,
        .authors_count = 1,
        .description = "A simple C plugin for Pumpkin",
        .dependencies_count = 0
    };
}

void on_load(plugin_own_context_t ctx) {
    printf("C plugin loaded!\n");
}

REGISTER_PUMPKIN_PLUGIN(((pumpkin_plugin_t){
    .get_metadata = get_meta,
    .on_load = on_load
}))

Building the plugin

To build your plugin into a WebAssembly component, use the clang compiler from your wasi-sdk installation.

Replace /path/to/wasi-sdk with the actual path to your WASI SDK.

/path/to/wasi-sdk/bin/clang -O3 \
    -Iinclude -Isrc/gen \
    src/gen/plugin.c src/pumpkin_api.c main.c \
    -o my_plugin.wasm \
    -mexec-model=reactor

This will generate a my_plugin.wasm file that you can place in the plugins folder of your Pumpkin server.