Your first plugin
Plugins are Rust code compiled into the server. There's no separate plugin jar or loader yet: you add your plugin to the source and rebuild.
Plugins only load when plugins=true is set in server.properties (it's off by default, so a
fresh server is plain vanilla).
1. Write it
Make a new file, src/greeter.rs:
#![allow(unused)] fn main() { use crate::players::{PlayerInfo, Server}; use crate::plugin::Plugin; pub struct Greeter; impl Plugin for Greeter { fn name(&self) -> &str { "greeter" } fn on_join(&self, server: &Server, player: &PlayerInfo) { server.broadcast(&format!("§e{} joined the game", player.name)); server.tell(player.id, "§aWelcome! Type /help to get started."); } } }
Every event has a default that does nothing, so you only write the ones you need.
Plugin info
These are optional, and /pl shows the name and version:
#![allow(unused)] fn main() { fn version(&self) -> &str { "1.2.0" } fn description(&self) -> &str { "Greets players" } fn authors(&self) -> &[&str] { &["Steve"] } /// Needed: if "economy" isn't loaded, this plugin isn't either. fn depends(&self) -> &[&str] { &["economy"] } /// Used if present: loads first when it's there, ignored when it isn't. fn soft_depends(&self) -> &[&str] { &["chat-format"] } }
Plugins load in dependency order: a plugin's on_server_start runs after the plugins it
depends on, and its on_server_stop runs before theirs.
To talk to another plugin, look it up by name with server.plugins.get("economy").
2. Register it
In src/main.rs, add the module next to the others:
#![allow(unused)] fn main() { mod greeter; }
Then add it to all() in src/plugin.rs:
#![allow(unused)] fn main() { pub fn all() -> Vec<Box<dyn Plugin>> { vec![Box::new(crate::greeter::Greeter)] } }
3. Build and test
cargo run --release
Join the server and you'll see the greeting. /pl lists loaded plugins, so greeter should
show up there.