feather-rs / feather

A Minecraft server implementation in Rust
Apache License 2.0
2.63k stars 143 forks source link

Plugin compilation #457

Open koskja opened 3 years ago

koskja commented 3 years ago

Missing Documentation

There isn't any documentation regarding how to compile a plugin, and cargo-quill itself isn't documented very well. I'm making this an issue because I don't know how to write good documentation. Steps to compile a plugin:

  1. Install cargo-quill by running cargo install --path quill/cargo-quill in the main folder
  2. Use cargo-quill in place of cargo when compiling a plugin - cargo-quill build
  3. Possibly use flags like --native, --release or --compression-level N