13
0
geforkt von Mirrors/Velocity
Velocity/README.md

48 Zeilen
2.0 KiB
Markdown

2018-07-25 02:17:56 +02:00
# Velocity
2018-12-26 09:42:21 +01:00
[![Build Status](https://img.shields.io/jenkins/s/https/ci.velocitypowered.com/job/velocity.svg)](https://ci.velocitypowered.com/job/velocity/)
2018-08-07 06:11:51 +02:00
[![Join our Discord](https://img.shields.io/discord/472484458856185878.svg?logo=discord&label=)](https://discord.gg/8cB9Bgf)
2018-07-31 21:03:13 +02:00
2018-09-20 22:58:38 +02:00
A Minecraft server proxy with unparalleled server support, scalability,
and flexibility.
2018-08-27 05:42:01 +02:00
Velocity is licensed under the MIT license for ultimate permissiveness
and expanding the pool of potential contributors and users.
2018-07-25 02:17:56 +02:00
## Goals
2018-08-27 05:42:01 +02:00
* A codebase that is easy to dive into and consistently follows best practices
for Java projects as much as reasonably possible.
2018-07-25 02:17:56 +02:00
* High performance: handle thousands of players on one proxy.
2018-08-27 05:42:01 +02:00
* A new, refreshing API built from the ground up to be flexible and powerful
whilst avoiding design mistakes and suboptimal designs from other proxies.
2018-07-26 20:02:13 +02:00
* First-class support for Paper, Sponge, and Forge. (Other implementations
may work, but we make every endeavor to support these server implementations
specifically.)
2018-07-31 21:48:52 +02:00
## 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.
2018-07-25 02:17:56 +02:00
## 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.
2018-07-25 02:17:56 +02:00
## Status
2018-08-27 05:42:01 +02:00
Velocity is currently in an alpha state: it is prone to change at any time and
2018-09-20 22:58:38 +02:00
is currently only suitable for small servers and development/testing.
2018-08-27 05:42:01 +02:00
2018-10-25 08:03:54 +02:00
Velocity supports Minecraft 1.8-1.13.2. Velocity is best supported with Paper
and SpongeVanilla. Minecraft Forge is fully supported but mod compatibility
may vary. Generally, Velocity will support many mods better than BungeeCord
2018-12-26 09:42:21 +01:00
or Waterfall do but compatibility can not always be ensured.