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

docs: Update workflow, add link to config file from setup

Browse Source
This commit is contained in:
William 2023-04-21 14:02:59 +01:00
parent 1926150717
commit c9d150a11d
No known key found for this signature in database
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/workflows/java_ci.yml vendored
View File

@ -4,6 +4,9 @@ name: Java CI
on: on:
push: push:
branches: [ 'master' ] branches: [ 'master' ]
paths-ignore:
- 'docs/**'
- 'README.md'
permissions: permissions:
contents: read contents: read

2
docs/Setup.md
View File

@ -13,6 +13,6 @@ This page will walk you through installing Velocitab on a Velocity proxy server.
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. 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. 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 4. Restart your proxy to let Velocitab generate its configuration file
5. Stop your proxy server, modify the `config.yml` 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. Velocitab should now be successfully installed on your proxy.