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

42 Zeilen
1.6 KiB
Markdown

2018-07-25 02:17:56 +02:00
# Velocity
2018-07-31 21:03:13 +02:00
[![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/)
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-07-26 20:02:13 +02:00
Velocity is a next-generation Minecraft: Java Edition proxy suite. It is
designed specifically with mass-scale Minecraft in mind.
2018-07-25 02:17:56 +02:00
## 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.
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-07-27 00:09:25 +02:00
Velocity is far from finished, but most of the essential pieces are in place:
2018-08-07 01:06:57 +02:00
you can switch between two servers running Minecraft 1.8-1.13. More versions
2018-07-30 02:37:27 +02:00
and functionality is planned.
2018-07-27 00:09:25 +02:00
You should join us on **irc.spi.gt** `#velocity` or send us a pull request.