From a031e2dc92185cacfdea7df66ca95582f95ada4e Mon Sep 17 00:00:00 2001 From: RaphiMC <50594595+RaphiMC@users.noreply.github.com> Date: Sat, 12 Oct 2024 12:53:09 +0200 Subject: [PATCH] Updated README --- README.md | 35 +++-------------------------------- docs/PLUGINS.md | 16 ---------------- 2 files changed, 3 insertions(+), 48 deletions(-) delete mode 100644 docs/PLUGINS.md diff --git a/README.md b/README.md index f930184..6306671 100644 --- a/README.md +++ b/README.md @@ -42,35 +42,6 @@ docker run -it -v /path/to/run:/app/run -p 25568:25568 ghcr.io/viaversion/viapro ``` where ``/path/to/run`` is the path where the ViaProxy data should be stored and ``25568`` is the port ViaProxy should listen on. -### Gradle/Maven -To use ViaProxy with Gradle/Maven you can use the ViaVersion maven server: -```groovy -repositories { - maven { url "https://repo.viaversion.com" } -} - -dependencies { - implementation("net.raphimc:ViaProxy:x.x.x") // Get latest version from releases -} -``` - -```xml - - - viaversion - https://repo.viaversion.com - - - - - - net.raphimc - ViaProxy - x.x.x - - -``` - ## Usage for Players (GUI) ![ViaProxy GUI](https://i.imgur.com/RaDWkbK.png) 1. Download the latest version from the [Releases section](#executable-jar-file) @@ -111,9 +82,9 @@ You will find 5 config files there: - viabedrock.yml (ViaBedrock) ### Developer Plugin API -ViaProxy has a plugin API which allows you to create plugins for ViaProxy. -Documentation for the plugin API can be found [here](https://github.com/ViaVersionAddons/NoLocalConnections?tab=readme-ov-file#how-to-make-a-viaproxy-plugin). -A list of plugins can be found [here](docs/PLUGINS.md). +ViaProxy has a plugin API which allows you to extend and modify the behavior of ViaProxy. +Documentation for the plugin API can be found [here](https://github.com/ViaVersion/ViaProxy/wiki/Creating-plugins). +A list of plugins can be found [here](https://github.com/ViaVersion/ViaProxy/wiki/Plugins). ## Contributing Contributions in the form of pull requests are always welcome. diff --git a/docs/PLUGINS.md b/docs/PLUGINS.md deleted file mode 100644 index baa4525..0000000 --- a/docs/PLUGINS.md +++ /dev/null @@ -1,16 +0,0 @@ -## List of ViaProxy plugins - -This is a list of ViaProxy plugins. If you want to add your plugin to this list, create a pull request. - -Official plugins: -- [Geyser](https://github.com/GeyserMC/Geyser/tree/master/bootstrap/viaproxy): Geyser integration. Allows bedrock clients to join the proxy -- [ViaProxyWhitelist](https://github.com/ViaVersionAddons/ViaProxyWhitelist): Only allow specified players to join the proxy -- [ViaProxyBeta2Release](https://github.com/ViaVersionAddons/ViaProxyBeta2Release): ViaProxy plugin which implements the Beta2Release proxy to allow the connection of beta client versions -- [ViaSnapshot](https://github.com/ViaVersionAddons/ViaSnapshot): Allows you to join servers from snapshot clients. Currently only supports 15w31a -- [ViaProxySpark](https://github.com/ViaVersionAddons/ViaProxySpark): Spark profiler integration -- [ViaProxyRakNetProviders](https://github.com/ViaVersionAddons/ViaProxyRakNetProviders): ViaProxy plugin which adds multiple alternative RakNet backends. Mostly used for testing -- [NoLocalConnections](https://github.com/ViaVersionAddons/NoLocalConnections): ViaProxy plugin denying connections to local servers. Useful for public ViaProxy instances -- [ViaProxyMultiLaunch](https://github.com/ViaVersionAddons/ViaProxyMultiLaunch): Launch another jar file in combination with ViaProxy - -Community plugins: -- [ayunViaProxyLegacyIcon](https://github.com/ayunami2000/ayunViaProxyLegacyIcon): Add server icon for newer clients when the backend server is too old to offer one