Velocity
latest

For Server Administrators

  • Getting started with Velocity
  • Commands
  • Configuring Velocity
  • Configuring player information forwarding
  • Frequently asked questions

For Developers

  • Creating your first plugin
  • The Command API
Velocity
  • Docs »
  • Welcome to Velocity’s documentation!
  • Edit on GitHub

Welcome to Velocity’s documentation!¶

Velocity is the next-generation Minecraft: Java Edition proxy. Velocity is built to be highly compatible with server software like Paper, Sponge, and modding platforms such as Minecraft Forge, while also exposing a rich plugin API and providing unparalleled scalability.

Note

This website is a work in progress. More documentation is coming soon.

For Server Administrators

  • Getting started with Velocity
    • Installing Java
    • Downloading Velocity
    • Configuring Your Servers
    • What’s Next?
  • Commands
    • The /velocity command
    • The /server command
    • The /shutdown command
  • Configuring Velocity
    • The configuration file
    • The default configuration
  • Configuring player information forwarding
    • Configuring modern forwarding
    • Configuring legacy BungeeCord-compatible forwarding
  • Frequently asked questions
    • What versions of Minecraft does Velocity support?
    • What server software is supported by Velocity?
    • Is Velocity compatible with my Forge mod(s)?
    • What is Velocity’s performance profile?

For Developers

  • Creating your first plugin
    • Set up your environment
    • I know how to do this. Give me what I need!
    • Setting up your first project
  • The Command API
    • Create the command class
    • How command arguments work
    • Creating a simple tab complete
Next

© Copyright 2019 the Velocity team Revision 4f26cded.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.