General cleanup

Author: Lenni0451

README.MD

@@ -4,112 +4,38 @@ This plugin is only needed if you want to host a public SRV mode proxy instance.
 
 ## SRV ViaProxy
 ### Running ViaProxy in SRV mode
-
-To use the SRV mode in ViaProxy you have to start it through the config.\
-Here are The config options require to make a Public SRV mode.
-```
+To use the SRV mode in ViaProxy you have to change some config options.
+```yaml
 bind-address: 0.0.0.0:25568 # will translate to viaproxy.0-0-0-0.nip.io:25568
-target-address: 127.0.0.1 # unused on srv mode.
-target-version: 1.8.x # unused on srv mode.
+target-address: 127.0.0.1 # unused in srv mode
+target-version: 1.8.x # unused in srv mode
 auth-method: OpenAuthMod
 wildcard-domain-handling: PUBLIC
 ```
+You have to replace `0.0.0.0:25568` with the address and port you want ViaProxy to run on.\
+The `auth-method: openauthmod` is optional and enables [OpenAuthMod](https://github.com/RaphiMC/OpenAuthMod) authentication. Check the caution below.\
+The `target-address` and `target-version` are required for ViaProxy to start but don't do anything in SRV mode.
+
+> <b>[CAUTION]</b>\
+> `auth-method: openauthmod` will not work for 1.7-1.7.10, 1.19.4+, Vanilla and Bedrock Edition.\
+> Reason:\
+> 1.7-1.7.10: OpenAuthMod is only available for 1.8+.\
+> Bedrock: Forge and Fabric don't support Bedrock Edition.\
+> 1.19.4+: OpenAuthMod was discontinued before release of 1.19.4.
 
-You have to replace ``0.0.0.0:<bind port>`` with the port you want ViaProxy to run on.\
-The ``auth-method: openauthmod`` is optional and enables the [OpenAuthMod](https://github.com/RaphiMC/OpenAuthMod) authentication. for 1.19.4 users, see the caution below.\
-The ``target-address`` and ``target-version`` are required for ViaProxy to start but don't do anything in SRV mode.
-> [!CAUTION]
-> warning: auth-method: openauthmod will be not functional for 1.7-1.7.10, Vanilla 1.8-1.19.3, 1.19.4-1.21.1, and Bedrock Edition.\
-> Reason: 1.7-1.7.10: OpenAuthMod is only available for 1.8.
-> Bedrock: Forge or Fabric don't support Bedrock Edition.\
-> 1.19.4+: OpenAuthMod discontinued before release of 1.19.4. use this option if you want to.
 ### Connecting to ViaProxy in SRV mode
 To connect to ViaProxy in SRV mode you need a domain pointing to the IP of the server running ViaProxy.\
-The subdomain ``viaproxy.`` is required for it to work.\
-For local connections you can use ``viaproxy.127-0-0-1.nip.io``.
+The subdomain `viaproxy.` is required for it to work.\
+For local connections you can use `viaproxy.127-0-0-1.nip.io`.
 
-To connect to a server through ViaProxy you have to prepend the ``server ip``, ``server port`` and ``version`` to your domain:
-````
+To connect to a server through ViaProxy you have to prepend the `server ip`, `server port` and `version` to your domain:
+```
 address_port_version.viaproxy.hostname
-````
+```
 
-For example to connect to ``lenni0451.net:39999`` with the version ``C0.30-CPE`` you can use:
-````
+For example to connect to `lenni0451.net:39999` with the version `C0.30-CPE` you can use:
+```
 lenni0451.net_39999_c0.30-cpe.viaproxy.127-0-0-1.nip.io
-````
+```
 
 If the domain of a server contains an underscore you currently can't connect to it since ViaProxy uses the underscore as a separator.
-
-## How to make a ViaProxy plugin
-### viaproxy.yml
-ViaProxy plugins require a ``viaproxy.yml`` file in the root of the plugin jar.\
-It defines the name, version, author, main class and minimum supported ViaProxy version of the plugin:
-````yaml
-name: "CoolPlugin"
-version: "1.0.0"
-author: "ExampleDude"
-main: "com.exampledude.coolplugin.Main"
-min-version: "3.0.0"
-````
-
-### Plugin Main
-The plugin main must extend ``ViaProxyPlugin`` and implement the ``onEnable`` method:
-````java
-public class Main extends ViaProxyPlugin {
-    @Override
-    public void onEnable() {
-    }
-}
-````
-
-There is an optional ``registerTransformers`` method that can be implemented to register class transformers **for the own plugin classes**:
-````java
-@Override
-public void registerTransformers(final TransformerManager transformerManager) {
-    transformerManager.addTransformer("com.exampledude.coolplugin.Transformer");
-}
-````
-
-Check out the [ClassTransform](https://github.com/Lenni0451/ClassTransform/#usage) documentation for more information on how to use class transformers.
-
-### Events
-The only real way to interact with ViaProxy is through events.\
-ViaProxy uses [LambdaEvents](https://github.com/Lenni0451/LambdaEvents) for event handling.\
-You can register a listener using the ``register()`` method in the ``PluginManager.EVENT_MANAGER``:
-````java
-PluginManager.EVENT_MANAGER.register(this);
-````
-
-ViaProxy currently (at the time of writing) has the following events:
- - Client2ProxyChannelInitializeEvent
- - Client2ProxyHandlerCreationEvent
- - ClientLoggedInEvent
- - ConnectEvent
- - ConsoleCommandEvent
- - FillPlayerDataEvent
- - GetDefaultPortEvent
- - PostOptionsParseEvent
- - PreConnectEvent
- - PreOptionsParseEvent
- - ProtocolHackInitEvent
- - Proxy2ServerChannelInitializeEvent
- - Proxy2ServerHandlerCreationEvent
- - ProxyStartEvent
- - ProxyStopEvent
- - ResolveSrvEvent
- - ViaLoadingEvent
-
-Some events have pre- and post-states and some events are cancellable.
-
-To listen to an event you have to add the ``@EventHandler`` annotation to the handler method and put the event as the only parameter:
-````java
-@EventHandler
-public void onPreConnect(final PreConnectEvent event) {
-}
-````
-
-### ViaVersion API
-Since ViaProxy uses ViaVersion for its protocol handling, the entire ViaVersion API is available.
-
-### Loading the plugin
-To load plugins just put the plugin jars in the ``plugins`` folder and ViaProxy will load them on startup.

build.gradle

@@ -1,13 +1,15 @@
 plugins {
-    id "java"
+    id "java-library"
 }
 
-java.toolchain.languageVersion = JavaLanguageVersion.of(17)
-compileJava.options.encoding = "UTF-8"
+base {
+    java.toolchain.languageVersion = JavaLanguageVersion.of(17)
+    compileJava.options.encoding = "UTF-8"
 
-archivesBaseName = project.maven_name
-group = project.maven_group
-version = project.maven_version
+    archivesName = project.maven_name
+    group = project.maven_group
+    version = project.maven_version
+}
 
 repositories {
     maven {

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
 package net.lenni0451.nolocalconnections;
 
-import net.lenni0451.nolocalconnections.KickMessageConfig;
 import net.lenni0451.lambdaevents.EventHandler;
 import net.raphimc.viaproxy.ViaProxy;
 import net.raphimc.viaproxy.plugins.ViaProxyPlugin;
@@ -13,14 +12,14 @@ public class Main extends ViaProxyPlugin {
 
     @Override
     public void onEnable() {
-        KickMessageConfig.load();
+        NoLocalConnectionsConfig.load(this.getDataFolder());
         ViaProxy.EVENT_MANAGER.register(this);
     }
 
     @EventHandler
-    public void onEvent(PreConnectEvent event) {
+    public void onEvent(final PreConnectEvent event) {
         if (!(event.getServerAddress() instanceof InetSocketAddress socketAddress)) return;
-        if (this.isLocal(socketAddress.getAddress())) event.setCancelMessage(KickMessageConfig.kick);
+        if (this.isLocal(socketAddress.getAddress())) event.setCancelMessage(NoLocalConnectionsConfig.kickMessage);
     }
 
     private boolean isLocal(final InetAddress address) {

gradlew

@@ -8,30 +8,30 @@
 import net.raphimc.viaproxy.util.logging.Logger;
 
 import java.io.File;
-import java.util.List;
 
 @OptConfig(header = {
         "Configuration for the NoLocalConnections ViaProxy plugin.",
-        "Used to block a Connection for Local Address Connections through ViaProxy(useful for address_port_version.viaproxy.hostname).",
+        "Used to block connections to local addresses through ViaProxy (useful for public SRV proxies).",
         "",
         "Made by Lenni0451",
         "Source: https://github.com/ViaVersionAddons/NoLocalConnections"
 })
-public class KickMessageConfig {
+public class NoLocalConnectionsConfig {
 
-    @Option("kick")
+    @Option("KickMessage")
     @Description({
-            "kick message when the user tries to join using local address such as 192.168.35.1. you can use the Decoration Codes here using Section Symbol(§)."
+            "Kick message when the user tries to connect local addresses such as 192.168.35.1",
+            "You can use color codes here using section symbol (§)."
     })
-    public static String kick = "§cYou can't connect to any local address.";
-  
-    public static void load() {
+    public static String kickMessage = "§cYou can't connect to any local address.";
+
+    public static void load(final File dataFolder) {
         try {
-            ConfigLoader<KickMessageConfig> configLoader = new ConfigLoader<>(KickMessageConfig.class);
+            ConfigLoader<NoLocalConnectionsConfig> configLoader = new ConfigLoader<>(NoLocalConnectionsConfig.class);
             configLoader.getConfigOptions().setResetInvalidOptions(true); //Reset invalid options to their default value
-            configLoader.loadStatic(ConfigProvider.file(new File("kickmessage.yml")));
+            configLoader.loadStatic(ConfigProvider.file(new File(dataFolder, "config.yml")));
         } catch (Throwable t) {
-            Logger.LOGGER.error("Unable to load kick message! turning off viaproxy...", t);
+            Logger.LOGGER.error("Unable to load config! Shutting down...", t);
             System.exit(-1);
         }
     }

gradlew.bat

@@ -2,4 +2,4 @@ name: "NoLocalConnections"
 version: "1.2"
 author: "Lenni0451"
 main: "net.lenni0451.nolocalconnections.Main"
-min-version: "3.1.0"
+min-version: "3.3.4"