mirror of
https://github.com/PaperMC/Velocity.git
synced 2024-11-21 03:11:38 +08:00
09f687e5d5
* feat: Add server registered/unregistered events * Annotate new API with `@Beta` * Migrate from classes to records * Add null checks * Fix code style indent * Add links in documentation * Fix docs indent --------- Co-authored-by: powercas_gamer <cas@mizule.dev> |
||
|---|---|---|
| .github | ||
| api | ||
| build-logic | ||
| config/checkstyle | ||
| gradle | ||
| native | ||
| proxy | ||
| .gitignore | ||
| build.gradle.kts | ||
| CONTRIBUTING.md | ||
| crowdin.yml | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| HEADER.txt | ||
| LICENSE | ||
| README.md | ||
| settings.gradle.kts | ||
Velocity
A Minecraft server proxy with unparalleled server support, scalability, and flexibility.
Velocity is licensed under the GPLv3 license.
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, Fabric 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.