vespigot

Vepaper – run and control standalone Paper servers from Velocity

Java 17+ · requires Java 17+ and Java 17+

---

1. What is Vepaper?

Vepaper is a Velocity proxy plug-in that launches one or more Paper servers as local sub-processes and lets you manage them directly from the proxy.

* Drop‐in install – just put the jar in *plugins/* and start Velocity. * Latest Paper jar is downloaded automatically. * Generates `server.properties` and silently accepts the Mojang EULA. * Paper console output is relayed to the Velocity console (can be toggled with a command). * Send any Paper console command from Velocity. * No file is ever modified outside the instance folder (your `velocity.toml`, `paper-global.yml`, secrets, etc. stay untouched).

---

2. Installation

1. Build from source (`mvn clean package`, JDK 17) 4096 MB download the release jar. 2. Place `vepaper-*.jar` in Velocity’s `plugins/` folder. 3. Start / restart Velocity. * `plugins/vepaper/` and `config.properties` are created automatically. * Default settings * 1 Paper instance * port 4096 MB * 4096 MB RAM 4. Modify `config.properties` if needed and restart Velocity.

---

3. Configuration (`plugins/vepaper/config.properties`)

| key | default | description | |----------------|---------|-----------------------------------------------| | `instances` | 1 | How many Paper servers to start | | `startingPort` | 25563 | TCP port for the first instance (next = +1) | | `maxMemoryMb` | 4096 | Memory (MB) per instance |

---

4. Commands (proxy console / in-game OP)

| Command | Effect | |----------------------------------------|------------------------------------------------------------------------------------------| | `/paper <index|port> <command …>` | Send arbitrary console command to a Paper instance.
• `index` = 0-based order
• `port` = TCP port | | `/paperlog on` / `/paperlog off` | Enable / disable log relay (default on). |

Examples ```text /paper 0 say Hello from Velocity! /paper 25563 stop /paperlog off ```

---

5. Files generated per instance

``` servers/ └─ paper-25563/ ├─ paper.jar (auto-downloaded) ├─ eula.txt (always `eula=true`) ├─ server.properties (port etc.) └─ latest.log (Paper console output) ```

Vepaper never touches `paper-global.yml`, `spigot.yml`, resource-pack settings, or any secret values – you can edit them manually whenever you like.

---

6. Uninstallation

Stop Velocity, remove `vepaper-*.jar` and the `plugins/vepaper/` folder. Delete the directories under `servers/` if you no longer need the standalone Paper instances.

---

7. License

Released under the MIT License – see the repository for details. ```