Fork/Velocitab
2
0
Fork 0
forked from Upstream/Velocitab
Code Pull Requests Actions Releases Activity

docs: Add links to Setup.md

Browse Source
This commit is contained in:
William 2023-04-21 14:39:51 +01:00
parent 83eeba89d3
commit 5f090b9f77
No known key found for this signature in database
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/Setup.md
View File

@ -10,9 +10,16 @@ This page will walk you through installing Velocitab on a Velocity proxy server.
1. Download the latest version of [Velocitab](https://modrinth.com/plugin/velocitab)
2. Drag both into the `/plugins/` folder on your Velocity proxy server
3. Download and install additional optional dependencies on your proxy and backend servers as needed:
1. If you'd like Velocitab to display user roles from [LuckPerms](https://luckperms.net/), ensure LuckPerms is installed on your proxy as well, and configured to synchronise role information via MySQL and Plugin Messages or Redis.
2. If you'd like to use [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) placeholders, install [PAPIProxyBridge](https://modrinth.com/plugin/papiproxybridge) on both your Velocity server and Spigot-based Minecraft servers. Also ensure PlaceholderAPI is installed on your spigot servers.
1. If you'd like Velocitab to display user roles from [LuckPerms](https://luckperms.net/), ensure LuckPerms is installed on your proxy as well, and configured to synchronise role information over your database
2. If you'd like to use [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/) placeholders, install [PAPIProxyBridge](https://modrinth.com/plugin/papiproxybridge) on both your Velocity server and Spigot-based Minecraft servers. Also ensure PlaceholderAPI is installed on your spigot servers
4. Restart your proxy to let Velocitab generate its configuration file
5. Stop your proxy server, modify the [`config.yml`](config-file) file to your liking, and start your server.
5. Stop your proxy server, modify the [`config.yml`](config-file) file to your liking, and start your server
Velocitab should now be successfully installed on your proxy.
## Next Steps
* [Configuring Velocitab](config-file)
* [Using Placeholders](placeholders)
* [Text Formatting](formatting)
* [Server Groups](server-groups)
* [Using Animations](animations)