Thank you all for over 10,000 downloads!
JsonApi
v3.1.0
(Incompatible with v2.x)
Using this API, you can very easily create and send JSON messages. They feature colors, bold/italic/etc., insertions, and most importantly, hover- and click actions.
Installation
- Download the latest version of JsonApi
- Place it in your server's plugins folder
- Restart your server
Commands
- /command - permission - description
- /jsonapi - jsonapi.command.jsonapi - Display version information
< For more detailed information, see the Javadocs >
Tutorial
Creating the message
Every good tutorial starts with a "Hello, World!" application. Let's create that JSON message!
The base class for creating JSON messages is JsonMsg.
Construct it with the appropriate text and color:
JsonMsg msg = new JsonMsg("Hello, ", JsonColor.AQUA);Notice that we specified the color using the JsonColor enum.
Also, see how we only put half of the text into the JsonMsg? That's because we want the other half to be another color, and italic. Let's see how that's done:
We'll first create the second half, but this time use the constructor JsonMsg(String, ChatColor...). It styles the message with all styles specified as ChatColors.
JsonMsg msg2 = new JsonMsg("world!", ChatColor.RED, ChatColor.ITALIC /*, ChatColor.BOLD, etc.*/);To add another JsonMsg to an existing one, use JsonMsg#append(JsonMsg) or JsonMsg#append(/* arguments from any constructor are valid */):
msg.append(msg2);All this could also be simplified to:
msg.append("world!", ChatColor.RED, ChatColor.ITALIC);There is another super easy way to create JSON messages:
Converting color-coded messages <-> JsonMsg
You can convert any color-code based message to a JsonMsg using the constructor JsonMsg(String text, boolean allowStyleFallthrough).
The allowStyleFallthrough parameter specifies whether the styles should be reset at every new "segment" of the text, where the segments are separated by a continuous set of color codes.
Example:
JsonMsg msg = new JsonMsg("§aHello, §o§lworld!", true);
// The §a (green color) carries over to "§o§lworld!",
// since it does not specify a color itself and allowStyleFallthrough is trueTo convert a JsonMsg back to a color-coded message, use the method JsonMsg.toConsoleMessage(boolean insertResetCodes). The insertResetCodes parameter specifies whether the message and each extra message should be prefixed with a reset code (§r).
Example:
String codeBased = msg.toConsoleMessage(true);
// codeBased is now "§r§r§aHello, §r§a§l§oworld!"Styling the message
Changing the color and styling of a JsonMsg could also not be simpler:
msg.color(JsonColor.GREEN); // Change the color
msg.underlined(true); // Underline the text
msg.style(ChatColor.GREEN, ChatColor.UNDERLINE); // Style the textThe corresponding values can be retrieved with the same method (except #style(ChatColor)), without arguments.
Tip: All methods that would otherwise return void return the JsonMsg object itself, so you can chain them together:
msg.color(JsonColor.GREEN).underlined(true);Now, let's get to the fun stuff!
Click & Hover Events
To show a text when the player hovers over msg, use any of these methods:
msg.hoverEvent(JsonHoverEvent.showText(msg2));
msg.hoverEvent(JsonHoverEvent.showText("Hey there!", JsonColor.GRAY));
msg.hoverEvent(JsonHoverEvent.showText("Hey there!", ChatColor.GRAY, ChatColor.BOLD));Of course, there are many more methods for showing items, achievements etc., and there is also the JsonClickEvent class.
Sending the message
Finally, we can send the message.
msg.send(player1, player2 /* , player3, etc. */);You can also use JsonMsg#send(Iterable<Player>) and JsonMsg#sendTitle(int, int, int, Player...).
Note: There are many more methods and tricks you can use, however, there are way too many to list them all here. Just experiment!
==> Go to the Wiki Page
==> Go to the Javadoc
Do not use this library without a reference to the author; ColoredCarrot, and the resource on spigot ( this link here) .
Do not mark this code as your own.
Original Thread:
https://www.spigotmc.org/threads/api-json-api-with-integrated-send-methods.136140/
Similar projects
Plugin →Let Me Despawn
Improves performance by tweaking mob despawn rules. Say bye to pesky unintentional persistent mobs.
26.2MSueta
JourneyMap
Real-time map used for mapping in-game or your browser as you explore.
15.6MSueta
Emotecraft
Create your own emotes in Minecraft.
7.9MSueta
Simple Tpa
A simple tpa plugin which sends requests
5.4MSueta
Common Network
Forge and Fabric Unified Networking Solution
4.7MSueta
Set Home
A lightweight plugin for players to set their homes.
3.8MSueta