3
0
Mirror von https://github.com/PaperMC/Velocity.git synchronisiert 2024-12-24 23:30:26 +01:00
Velocity/README.md
Andrew Steinborn d68cbbd906 Remove inaccurate "Status" section
I'm just one person, I can't keep this stuff updated everywhere.
2019-08-17 20:12:09 -04:00

37 Zeilen
1.5 KiB
Markdown

# Velocity
[![Build Status](https://img.shields.io/jenkins/s/https/ci.velocitypowered.com/job/velocity.svg)](https://ci.velocitypowered.com/job/velocity/)
[![Join our Discord](https://img.shields.io/discord/472484458856185878.svg?logo=discord&label=)](https://discord.gg/8cB9Bgf)
A Minecraft server proxy with unparalleled server support, scalability,
and flexibility.
Velocity is licensed under the MIT license for ultimate permissiveness
and expanding the pool of potential contributors and users.
## Goals
* A codebase that is easy to dive into and consistently follows best practices
for Java projects as much as reasonably possible.
* High performance: handle thousands of players on one proxy.
* A new, refreshing API built from the ground up to be flexible and powerful
whilst avoiding design mistakes and suboptimal designs from other proxies.
* 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.
## 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.