2018-07-25 02:17:56 +02:00
|
|
|
# Velocity
|
|
|
|
|
|
2018-07-31 21:03:13 +02:00
|
|
|
[](https://ci.velocitypowered.com/job/velocity/job/master/)
|
2018-08-07 06:11:51 +02:00
|
|
|
[](https://discord.gg/8cB9Bgf)
|
2018-07-31 21:03:13 +02:00
|
|
|
|
2018-07-26 20:02:13 +02:00
|
|
|
Velocity is a next-generation Minecraft: Java Edition proxy suite. It is
|
2018-08-27 05:42:01 +02:00
|
|
|
designed specifically for enhanced server support and scalability whilst
|
|
|
|
|
not compromising flexibility.
|
|
|
|
|
|
|
|
|
|
Velocity is licensed under the MIT license for ultimate permissiveness
|
|
|
|
|
and expanding the pool of potential contributors and users.
|
2018-07-25 02:17:56 +02:00
|
|
|
|
|
|
|
|
## Goals
|
|
|
|
|
|
2018-08-27 05:42:01 +02:00
|
|
|
* A codebase that is easy to dive into and consistently follows best practices
|
|
|
|
|
for Java projects as much as reasonably possible.
|
2018-07-25 02:17:56 +02:00
|
|
|
* High performance: handle thousands of players on one proxy.
|
2018-08-27 05:42:01 +02:00
|
|
|
* A new, refreshing API built from the ground up to be flexible and powerful
|
|
|
|
|
whilst avoiding design mistakes and suboptimal designs from other proxies.
|
2018-07-26 20:02:13 +02: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-07-31 21:48:52 +02: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 02:17:56 +02:00
|
|
|
|
2018-08-07 15:34:31 +02: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 02:17:56 +02:00
|
|
|
## Status
|
|
|
|
|
|
2018-08-27 05:42:01 +02:00
|
|
|
Velocity is currently in an alpha state: it is prone to change at any time and
|
|
|
|
|
is not currently suitable for production usage. For development and testing
|
|
|
|
|
purposes, however, Velocity is fully-fledged and ready to go.
|
|
|
|
|
|
|
|
|
|
Velocity supports Minecraft 1.8-1.13.1, and has full support for Paper and Sponge.
|
|
|
|
|
Forge support is currently not implemented, but Velocity will work with Forge's
|
|
|
|
|
vanilla fallback mode.
|
