[SPIGOT-6304] TextComponent outputting garbage into books Created: 02/Jan/21  Updated: 03/Jan/21  Resolved: 03/Jan/21

Status: Resolved
Project: Spigot
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major
Reporter: MagmaGuy Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: Book, TextComponent, bug
Environment:

It's been reported to me by dozens of users that use my plugin on dozens of different machines.

Version: git-Spigot-ff439d1-24c79a1
Plugin: EliteMobs
Guidelines Read: Yes

 Description   

Very recently TextComponent started outputting garbage into books. I heavily rely on a wide array of features of TextComponent to write books, and I was told an update recently did some major changes to these systems. It would seem that even after the most recent patch there are still some lingering issues.

 

Code that I am using (snippet, full code is available on github if needed): https://hatebin.com/btspfqjafl

 

To save you some time: line 137 for the TextComponent, line 89 and on for it getting inserted into the book, line 109 for how I'm setting hover text, line 201 for generating the book itself.

 

Visual output:

 

What it is supposed to look like (still working for all users that haven't updated spigot in the last few days) :

 

 

 Comments   
Comment by blablubbabc [ 03/Jan/21 ]

I can reproduce the issue for components containing legacy color codes. My current guess is that the item's data is converted to Bukkit item meta and back to the Minecraft item (for example as part of Spigot's stricter item validation when the book item is sent to the client; but this also occurs in other situations). Due to some older issue, the item might contain page data in either JSON text or as legacy text. The previous approach has been to check if the data can be parsed as JSON, and otherwise assume that it is plain text. The recent change also takes into account whether the text contains color codes (https://hub.spigotmc.org/stash/projects/SPIGOT/repos/craftbukkit/browse/src/main/java/org/bukkit/craftbukkit/inventory/CraftMetaBook.java#111).

Since these components seem to contain color codes inside their text contents, their JSON text is currently interpreted as legacy text when the item meta is created for a given Minecraft ItemStack. A possible fix could therefore be to revert this and only check if the text can be parsed as JSON.

However, if we drop the assumption that components do not contain legacy color codes, the check for legacy color codes would then also need to be removed when we deserialize items from config files.

I will do some testing to see if I find any immediate issues with this approach and prepare a PR later.

Comment by Black Hole [ 02/Jan/21 ]

I've seem some old (pre 1.13) books that contain legacy color codes in components. Those books will be converted if taken in the inventory of a player and all pages will look like in the first picture.

Comment by md_5 [ 02/Jan/21 ]

blablubbabc

Generated at Thu Apr 03 15:33:32 UTC 2025 using Jira 10.3.3#10030003-sha1:d220e3fefc8dfc6d47f522d3b9a20c1455e12b7b.