MiniDay/Velocity
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Expand README

Browse Source
This commit is contained in:
Andrew Steinborn
2018-08-26 23:42:01 -04:00
parent db3f2b86e1
commit 42f0dbf646
1 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -4,14 +4,19 @@
[![Join our Discord](https://img.shields.io/discord/472484458856185878.svg?logo=discord&label=)](https://discord.gg/8cB9Bgf) [![Join our Discord](https://img.shields.io/discord/472484458856185878.svg?logo=discord&label=)](https://discord.gg/8cB9Bgf)
Velocity is a next-generation Minecraft: Java Edition proxy suite. It is Velocity is a next-generation Minecraft: Java Edition proxy suite. It is
designed specifically with mass-scale Minecraft in mind. designed specifically for enhanced server support and scalability whilst
not compromising flexibility.
Velocity is licensed under the MIT license for ultimate permissiveness
and expanding the pool of potential contributors and users.
## Goals ## Goals
* Simple, easy to understand codebase. * 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. * High performance: handle thousands of players on one proxy.
* Flexible API built for mass-scale Minecraft. * A new, refreshing API built from the ground up to be flexible and powerful
* Licensed under the MIT license. whilst avoiding design mistakes and suboptimal designs from other proxies.
* First-class support for Paper, Sponge, and Forge. (Other implementations * First-class support for Paper, Sponge, and Forge. (Other implementations
may work, but we make every endeavor to support these server implementations may work, but we make every endeavor to support these server implementations
specifically.) specifically.)
@@ -34,6 +39,10 @@ page.
## Status ## Status
Velocity is far from finished, but most of the essential pieces you would Velocity is currently in an alpha state: it is prone to change at any time and
expect are in place. Velocity supports Minecraft 1.8-1.13. More functionality is not currently suitable for production usage. For development and testing
is planned. purposes, however, Velocity is fully-fledged and ready to go.
Velocity supports Minecraft 1.8-1.13.1, and has full support for Paper and Sponge.
Forge support is currently not implemented, but Velocity will work with Forge's
vanilla fallback mode.