From d515f0138c5823702a25adabdc16862ff8d86263 Mon Sep 17 00:00:00 2001 From: Oskar Nordling Date: Mon, 10 Feb 2025 00:28:23 +0100 Subject: [PATCH 1/3] #39: fix spelling, punctuation, and code-style --- README.md | 67 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 37 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index c2f4c14..44d2174 100644 --- a/README.md +++ b/README.md @@ -12,19 +12,23 @@ # [StaffChat](https://oskar3123.github.io/StaffChat) -Simple and highly configurable staffchat +Simple and highly configurable staff chat. ## Download -You can download the plugin from the [Spigot resource page](https://www.spigotmc.org/resources/37804/) or via the [GitHub releases](https://github.com/oskar3123/StaffChat/releases) +You can download the plugin from +the [Spigot resource page](https://www.spigotmc.org/resources/37804/) or via +the [GitHub releases](https://github.com/oskar3123/StaffChat/releases). ## License -This plugin is licensed with the MIT License, for more information see the [LICENSE file](https://github.com/oskar3123/StaffChat/blob/master/LICENSE) +This plugin is licensed with the MIT License, for more information see +the [LICENSE file](https://github.com/oskar3123/StaffChat/blob/master/LICENSE). ## Building -To build this yourself just clone the repository and run the `shadowJar` task with the Gradle Wrapper +To build this yourself just clone the repository and run the `shadowJar` task with the Gradle +Wrapper. ### Windows @@ -46,52 +50,53 @@ cd StaffChat ### Bukkit/Spigot -Because the event API in 1.14+ is now strict between sync and async events you should check whether this was called synchronously or asynchronously by using `event.isAsynchronous()` +Because the event API in 1.14+ is now strict between sync and async events you should check whether +this was called synchronously or asynchronously by using `event.isAsynchronous()`. ```java -public class StaffChatListener implements Listener -{ - - @EventHandler - public void onStaffChat(StaffChatEvent event) - { - // String format = event.getFormat(); - // event.setFormat("&b{NAME} >> {MESSAGE}"); - // String message = event.getMessage(); - // Player player = event.getPlayer(); - // event.setCancelled(true); - } +public class StaffChatListener implements Listener { + @EventHandler + public void onStaffChat(StaffChatEvent event) { + // String format = event.getFormat(); + // event.setFormat("&b{NAME} >> {MESSAGE}"); + // String message = event.getMessage(); + // Player player = event.getPlayer(); + // event.setCancelled(true); + } } ``` + Register the listener with + ```java getServer().getPluginManager().registerEvents(new StaffChatListener(), this); ``` + in your plugin onEnable. ### BungeeCord ```java -public class StaffChatListener implements Listener -{ - - @EventHandler - public void onStaffChat(BungeeStaffChatEvent event) - { - // String format = event.getFormat(); - // event.setFormat("&b{NAME} >> {MESSAGE}"); - // String message = event.getMessage(); - // Player player = event.getPlayer(); - // event.setCancelled(true); - } +public class StaffChatListener implements Listener { + @EventHandler + public void onStaffChat(BungeeStaffChatEvent event) { + // String format = event.getFormat(); + // event.setFormat("&b{NAME} >> {MESSAGE}"); + // String message = event.getMessage(); + // Player player = event.getPlayer(); + // event.setCancelled(true); + } } ``` + Register the listener with + ```java getProxy().getPluginManager().registerListener(this, new StaffChatListener()); ``` + in your plugin onEnable. ### Velocity @@ -117,7 +122,9 @@ public class StaffChatListener { } } ``` + Register the listener on the `ProxyInitializeEvent` in your plugin. + ```java @Plugin public class Plugin { @@ -134,4 +141,4 @@ public class Plugin { server.getEventManager().register(this, new StaffChatListener()); } } -``` \ No newline at end of file +``` From 02ef475267f08daec5b2def086e426d78a72275d Mon Sep 17 00:00:00 2001 From: Oskar Nordling Date: Mon, 10 Feb 2025 00:28:48 +0100 Subject: [PATCH 2/3] #39: improve build instructions --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 44d2174..23f6e08 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,8 @@ the [LICENSE file](https://github.com/oskar3123/StaffChat/blob/master/LICENSE). To build this yourself just clone the repository and run the `shadowJar` task with the Gradle Wrapper. +The plugin jar-file can be found inside the `build/libs` folder after building. + ### Windows ```bat From 428adde024fd8e48d77ca1fed151989843ced102 Mon Sep 17 00:00:00 2001 From: Oskar Nordling Date: Mon, 10 Feb 2025 00:36:10 +0100 Subject: [PATCH 3/3] #39: update code-examples --- README.md | 50 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 23f6e08..da9f765 100644 --- a/README.md +++ b/README.md @@ -60,22 +60,32 @@ public class StaffChatListener implements Listener { @EventHandler public void onStaffChat(StaffChatEvent event) { - // String format = event.getFormat(); - // event.setFormat("&b{NAME} >> {MESSAGE}"); - // String message = event.getMessage(); // Player player = event.getPlayer(); + // String format = event.getFormat(); + // String message = event.getMessage(); + // event.setFormat("&b{NAME} >> {MESSAGE}"); + // event.setMessage(filterMessage(message)); // event.setCancelled(true); } + + private static String filterMessage(String message) { + // ... + return message; + } } ``` -Register the listener with +Register the listener in the `onEnable` method of your plugin. ```java -getServer().getPluginManager().registerEvents(new StaffChatListener(), this); -``` +public class YourPlugin extends JavaPlugin { -in your plugin onEnable. + @Override + public void onEnable() { + getServer().getPluginManager().registerEvents(new StaffChatListener(), this); + } +} +``` ### BungeeCord @@ -84,22 +94,32 @@ public class StaffChatListener implements Listener { @EventHandler public void onStaffChat(BungeeStaffChatEvent event) { + // ProxiedPlayer player = event.getPlayer(); // String format = event.getFormat(); - // event.setFormat("&b{NAME} >> {MESSAGE}"); // String message = event.getMessage(); - // Player player = event.getPlayer(); + // event.setFormat("&b{NAME} >> {MESSAGE}"); + // event.setMessage(filterMessage(message)); // event.setCancelled(true); } + + private static String filterMessage(String message) { + // ... + return message; + } } ``` -Register the listener with +Register the listener in the `onEnable` method of your plugin. ```java -getProxy().getPluginManager().registerListener(this, new StaffChatListener()); -``` +public class YourPlugin extends Plugin { -in your plugin onEnable. + @Override + public void onEnable() { + getProxy().getPluginManager().registerListener(this, new StaffChatListener()); + } +} +``` ### Velocity @@ -129,12 +149,12 @@ Register the listener on the `ProxyInitializeEvent` in your plugin. ```java @Plugin -public class Plugin { +public class YourPlugin { private final ProxyServer server; @Inject - public Plugin(ProxyServer server) { + public YourPlugin(ProxyServer server) { this.server = server; }