Go to file
2023-01-01 18:58:27 -05:00
.github don't build on Java 8 2021-05-23 14:15:22 -04:00
api Also use Spotless to remove unused imports 2023-01-01 18:52:11 -05:00
buildSrc Also use Spotless to remove unused imports 2023-01-01 18:52:11 -05:00
config/checkstyle Use Spotless for license formatting 2023-01-01 18:46:33 -05:00
gradle/wrapper Convert Velocity buildscripts to Kotlin DSL (#918) 2023-01-01 17:53:37 -05:00
native Use Spotless for license formatting 2023-01-01 18:46:33 -05:00
proxy Update various other dependencies 2023-01-01 18:58:27 -05:00
.gitignore Update to 1.19.3-rc3 (#893) 2022-12-07 14:12:48 +01:00
build.gradle.kts Use Spotless for license formatting 2023-01-01 18:46:33 -05:00
CONTRIBUTING.md Update CONTRIBUTING.md 2021-01-22 19:50:31 -05:00
crowdin.yml Update Crowdin configuration file 2022-08-07 10:56:43 -04:00
gradle.properties Update various other dependencies 2023-01-01 18:58:27 -05:00
gradlew Update Gradle wrapper 2022-12-07 14:09:01 +01:00
gradlew.bat misc build changes 2021-12-09 10:29:32 -08:00
HEADER.txt Use Spotless for license formatting 2023-01-01 18:46:33 -05:00
Jenkinsfile Disallow all concurrent builds. 2018-12-07 17:25:04 -05:00
LICENSE Relicense the Velocity proxy under the terms of GPLv3 (#448) 2021-03-31 16:04:06 -04:00
README.md Update old downloads URL (#660) 2022-03-06 13:20:44 -05:00
settings.gradle.kts Convert Velocity buildscripts to Kotlin DSL (#918) 2023-01-01 17:53:37 -05:00

Velocity

Build Status Join our Discord

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