3
0
Mirror von https://github.com/PaperMC/Velocity.git synchronisiert 2024-11-16 21:10:30 +01:00
Velocity/README.md
Andrew Steinborn f9fd58eea5 Update README.
2018-07-31 15:48:52 -04:00

32 Zeilen
1.1 KiB
Markdown

# Velocity
[![Build Status](https://img.shields.io/jenkins/s/https/ci.velocitypowered.com/job/velocity/job/master.svg)](https://ci.velocitypowered.com/job/velocity/job/master/)
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](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.
## Status
Velocity is far from finished, but most of the essential pieces are in place:
you can switch between two servers running Minecraft 1.9-1.13. More versions
and functionality is planned.
You should join us on **irc.spi.gt** `#velocity` or send us a pull request.