2018-07-25 08:17:56 +08:00
|
|
|
# Velocity
|
|
|
|
|
|
2018-08-01 03:03:13 +08:00
|
|
|
[](https://ci.velocitypowered.com/job/velocity/job/master/)
|
2018-08-07 12:11:51 +08:00
|
|
|
[](https://discord.gg/8cB9Bgf)
|
2018-08-01 03:03:13 +08:00
|
|
|
|
2018-07-27 02:02:13 +08:00
|
|
|
Velocity is a next-generation Minecraft: Java Edition proxy suite. It is
|
|
|
|
|
designed specifically with mass-scale Minecraft in mind.
|
2018-07-25 08:17:56 +08:00
|
|
|
|
|
|
|
|
## Goals
|
|
|
|
|
|
|
|
|
|
* Simple, easy to understand codebase.
|
|
|
|
|
* High performance: handle thousands of players on one proxy.
|
|
|
|
|
* Flexible API built for mass-scale Minecraft.
|
|
|
|
|
* Licensed under the MIT license.
|
2018-07-27 02:02:13 +08:00
|
|
|
* First-class support for Paper, Sponge, and Forge. (Other implementations
|
|
|
|
|
may work, but we make every endeavor to support these server implementations
|
|
|
|
|
specifically.)
|
2018-08-01 03:48:52 +08:00
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
Velocity is built with [Gradle](https://gradle.org). We recommend using the
|
|
|
|
|
wrapper script (`./gradlew`) as our CI builds using it.
|
|
|
|
|
|
|
|
|
|
It is sufficient to run `./gradlew build` to run the full build cycle.
|
2018-07-25 08:17:56 +08:00
|
|
|
|
2018-08-07 21:34:31 +08:00
|
|
|
## Running
|
|
|
|
|
|
|
|
|
|
Once you've built Velocity, you can copy and run the `-all` JAR from
|
|
|
|
|
`proxy/build/libs`. Velocity will generate a default configuration file
|
|
|
|
|
and you can configure it from there.
|
|
|
|
|
|
|
|
|
|
Alternatively, you can get the proxy JAR from the [downloads](https://www.velocitypowered.com/downloads)
|
|
|
|
|
page.
|
|
|
|
|
|
2018-07-25 08:17:56 +08:00
|
|
|
## Status
|
|
|
|
|
|
2018-08-08 21:22:47 +08:00
|
|
|
Velocity is far from finished, but most of the essential pieces you would
|
|
|
|
|
expect are in place. Velocity supports Minecraft 1.8-1.13. More functionality
|
|
|
|
|
is planned.
|
