mirror/Velocity
2
0
Fork 0
mirror of https://github.com/PaperMC/Velocity.git synced 2024-11-21 03:11:38 +08:00
Code Issues Packages Projects Releases Wiki Activity
738be8d535
Velocity/README.md
Andrew Steinborn 84717a11da
Update README.md
2018-08-08 09:22:47 -04:00

1.5 KiB
Raw Blame History

Velocity

Build Status Join our Discord

Velocity is a next-generation Minecraft: Java Edition proxy suite. It is designed specifically with mass-scale Minecraft in mind.

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.
  • First-class support for Paper, Sponge, and Forge. (Other implementations may work, but we make every endeavor to support these server implementations specifically.)

Building

Velocity is built with Gradle. 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.

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 page.

Status

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.