Add Support for Scoreboard Teams on Folia

main/pom.xml

@@ -11,7 +11,7 @@
     <artifactId>citizens-main</artifactId>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <craftbukkit.version>26.1.1-R0.1-SNAPSHOT</craftbukkit.version>
+        <craftbukkit.version>26.1.2-R0.1-SNAPSHOT</craftbukkit.version>
         <paper.version>[26.1.1, 26.1.2)</paper.version>
         <placeholderapi.version>2.11.5</placeholderapi.version>
         <citizensapi.version>${project.version}</citizensapi.version>
@@ -147,6 +147,18 @@
             <version>0.10.2</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>net.megavex</groupId>
+            <artifactId>scoreboard-library-api</artifactId>
+            <version>2.7.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>net.megavex</groupId>
+            <artifactId>scoreboard-library-implementation</artifactId>
+            <version>2.7.0</version>
+            <scope>runtime</scope>
+        </dependency>
     </dependencies>
     <url>http://www.citizensnpcs.co</url>
     <ciManagement>
@@ -268,6 +280,12 @@
                                         <include>**</include>
                                     </includes>
                                 </filter>
+                                <filter>
+                                    <artifact>net.megavex:scoreboard-library-*</artifact>
+                                    <includes>
+                                        <include>**</include>
+                                    </includes>
+                                </filter>
                             </filters>
                             <relocations>
                                 <!--
@@ -284,6 +302,10 @@
                                     <pattern>net.byteflux.libby</pattern>
                                     <shadedPattern>clib.net.byteflux.libby</shadedPattern>
                                 </relocation>
+                                <relocation>
+                                    <pattern>net.megavex.scoreboardlibrary</pattern>
+                                    <shadedPattern>clib.net.megavex.scoreboardlibrary</shadedPattern>
+                                </relocation>
                             </relocations>
                         </configuration>
                     </execution>

main/src/main/java/net/citizensnpcs/Citizens.java

@@ -10,6 +10,10 @@
 import java.util.Map;
 import java.util.UUID;
 
+import net.megavex.scoreboardlibrary.api.ScoreboardLibrary;
+import net.megavex.scoreboardlibrary.api.exception.NoPacketAdapterAvailableException;
+import net.megavex.scoreboardlibrary.api.noop.NoopScoreboardLibrary;
+import net.megavex.scoreboardlibrary.api.team.TeamManager;
 import org.bukkit.Bukkit;
 import org.bukkit.OfflinePlayer;
 import org.bukkit.command.BlockCommandSender;
@@ -96,6 +100,8 @@ public class Citizens extends JavaPlugin implements CitizensPlugin {
     private boolean enabled;
     private ExpressionRegistry expressionRegistry;
     private LocationLookup locationLookup;
+    private ScoreboardLibrary scoreboardLibrary;
+    private TeamManager teamManager;
     private final NMSHelper nmsHelper = new NMSHelper() {
         private boolean SUPPORT_OWNER_PROFILE = false;
         {
@@ -315,6 +321,10 @@ public TraitFactory getTraitFactory() {
         return traitFactory;
     }
 
+    public TeamManager getTeamManager() {
+        return teamManager;
+    }
+
     private void initialiseBehaviorRegistry() {
         expressionRegistry = new ExpressionRegistry();
         expressionRegistry.registerEngine(new MolangEngine());
@@ -364,6 +374,12 @@ private void loadAdventure() {
                 .relocate("net{}kyori", "clib{}net{}kyori").build());
         lib.loadLibrary(Library.builder().groupId("net{}kyori").artifactId("adventure-platform-viaversion")
                 .version("4.4.1").relocate("net{}kyori", "clib{}net{}kyori").build());
+
+
+        lib.loadLibrary(Library.builder().groupId("net{}megavex").artifactId("scoreboard-library-api")
+                .version("2.7.0").relocate("net{}megavex{}scoreboardlibrary", "clib{}net{}megavex{}scoreboardlibrary").build());
+        lib.loadLibrary(Library.builder().groupId("net{}megavex").artifactId("scoreboard-library-implementation")
+                .version("2.7.0").relocate("net{}megavex{}scoreboardlibrary", "clib{}net{}megavex{}scoreboardlibrary").build());
     }
 
     @Override
@@ -405,6 +421,8 @@ public void onDisable() {
         if (packetEventsEnabled) {
             PacketEvents.getAPI().terminate();
         }
+
+        scoreboardLibrary.close();
     }
 
     @Override
@@ -475,6 +493,13 @@ public void onEnable() {
             Messaging.severeTr(Messages.LOAD_TASK_NOT_SCHEDULED);
             Bukkit.getPluginManager().disablePlugin(this);
         }
+
+        try {
+            scoreboardLibrary = ScoreboardLibrary.loadScoreboardLibrary(this);
+            teamManager = scoreboardLibrary.createTeamManager();
+        } catch (NoPacketAdapterAvailableException e) {
+            scoreboardLibrary = new NoopScoreboardLibrary();
+        }
     }
 
     @Override

main/src/main/java/net/citizensnpcs/npc/CitizensNPC.java

@@ -77,7 +77,7 @@ public class CitizensNPC extends AbstractNPC {
     private int updateCounter = 0;
 
     public CitizensNPC(UUID uuid, int id, String name, EntityController controller, NPCRegistry registry,
-            CitizensPlugin plugin) {
+                       CitizensPlugin plugin) {
         super(uuid, id, name, registry, plugin);
         setEntityController(controller);
     }
@@ -414,7 +414,7 @@ public void accept(Runnable cancel) {
                         if (type == EntityType.PLAYER || Util.isHorse(type)) {
                             if (SUPPORT_ATTRIBUTES && !hasTrait(AttributeTrait.class)
                                     || !getTrait(AttributeTrait.class).hasAttribute(SpigotUtil.getRegistryValue(
-                                            Registry.ATTRIBUTE, "generic.step_height", "step_height"))) {
+                                    Registry.ATTRIBUTE, "generic.step_height", "step_height"))) {
                                 NMS.setStepHeight(entity, 1);
                             }
                         }
@@ -629,7 +629,7 @@ public void update() {
             if (isLiving) {
                 if (!SUPPORT_ATTRIBUTES || !hasTrait(AttributeTrait.class)
                         || !getTraitNullable(AttributeTrait.class).hasAttribute(SpigotUtil.getRegistryValue(
-                                Registry.ATTRIBUTE, "generic.knockback_resistance", "knockback_resistance"))) {
+                        Registry.ATTRIBUTE, "generic.knockback_resistance", "knockback_resistance"))) {
                     NMS.setKnockbackResistance((LivingEntity) getEntity(), isProtected() ? 1D : 0D);
                 }
                 if (SUPPORT_PICKUP_ITEMS) {

main/src/main/java/net/citizensnpcs/trait/ScoreboardTrait.java

@@ -2,14 +2,16 @@
 
 import java.util.Set;
 
+import net.citizensnpcs.trait.scoreboard.AbstractScoreboard;
+import net.citizensnpcs.trait.scoreboard.AbstractTeam;
+import net.citizensnpcs.trait.scoreboard.BukkitScoreboardImpl;
+import net.citizensnpcs.trait.scoreboard.FoliaScoreboardImpl;
 import org.bukkit.Bukkit;
 import org.bukkit.ChatColor;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.LivingEntity;
 import org.bukkit.entity.Player;
-import org.bukkit.scoreboard.Scoreboard;
 import org.bukkit.scoreboard.Team;
-import org.bukkit.scoreboard.Team.Option;
 import org.bukkit.scoreboard.Team.OptionStatus;
 
 import com.google.common.collect.Iterables;
@@ -25,7 +27,6 @@
 import net.citizensnpcs.api.trait.TraitName;
 import net.citizensnpcs.api.util.DataKey;
 import net.citizensnpcs.api.util.SpigotUtil;
-import net.citizensnpcs.util.NMS;
 import net.citizensnpcs.util.Util;
 
 @TraitName("scoreboardtrait")
@@ -39,6 +40,8 @@ public class ScoreboardTrait extends Trait {
     @Persist
     private Set<String> tags = Sets.newHashSet("CITIZENS_NPC");
 
+    private final AbstractScoreboard scoreboard;
+
     public ScoreboardTrait() {
         super("scoreboardtrait");
         metadata = CitizensAPI.getLocationLookup().<Boolean> registerMetadata("scoreboard", (meta, event) -> {
@@ -47,34 +50,33 @@ public ScoreboardTrait() {
                 if (trait == null)
                     continue;
 
-                Team team = trait.getTeam();
+                AbstractTeam team = trait.getTeam();
                 if (team == null || meta.has(event.getPlayer().getUniqueId(), team.getName()))
                     continue;
 
-                NMS.sendTeamPacket(event.getPlayer(), team, 0);
+                team.sendToPlayer(event.getPlayer(), AbstractTeam.SendMode.ADD_OR_MODIFY);
 
                 meta.set(event.getPlayer().getUniqueId(), team.getName(), true);
             }
         });
+
+        this.scoreboard = SpigotUtil.isFoliaServer() ? new FoliaScoreboardImpl() : new BukkitScoreboardImpl();
     }
 
-    private void clearClientTeams(Team team) {
+    private void clearClientTeams(AbstractTeam team) {
         for (Player player : Bukkit.getOnlinePlayers()) {
             if (metadata.remove(player.getUniqueId(), team.getName())) {
-                NMS.sendTeamPacket(player, team, 1);
+                team.sendToPlayer(player, AbstractTeam.SendMode.REMOVE);
             }
         }
     }
 
     public void createTeam(String entityName) {
-        if (SpigotUtil.isFoliaServer())
-            return; // not supported on Folia
         String teamName = Util.getTeamName(npc.getUniqueId());
         npc.data().set(NPC.Metadata.SCOREBOARD_FAKE_TEAM_NAME, teamName);
-        Scoreboard scoreboard = Util.getDummyScoreboard();
-        Team team = scoreboard.getTeam(teamName);
+        AbstractTeam team = scoreboard.getTeam(teamName);
         if (team == null) {
-            team = scoreboard.registerNewTeam(teamName);
+            team = scoreboard.createTeam(teamName);
         }
         if (!team.hasEntry(entityName)) {
             clearClientTeams(team);
@@ -86,11 +88,11 @@ public ChatColor getColor() {
         return color;
     }
 
-    private Team getTeam() {
+    private AbstractTeam getTeam() {
         String teamName = npc.data().get(NPC.Metadata.SCOREBOARD_FAKE_TEAM_NAME, "");
         if (teamName.isEmpty())
             return null;
-        return Util.getDummyScoreboard().getTeam(teamName);
+        return scoreboard.getTeam(teamName);
     }
 
     @Override
@@ -102,20 +104,18 @@ public void load(DataKey key) {
 
     @Override
     public void onDespawn(DespawnReason reason) {
-        if (SpigotUtil.isFoliaServer())
-            return; // Not Supported on Folia
         previousGlowingColor = null;
         String name = lastName;
         String teamName = npc.data().get(NPC.Metadata.SCOREBOARD_FAKE_TEAM_NAME, "");
         if (teamName.isEmpty())
             return;
-        Team team = Util.getDummyScoreboard().getTeam(teamName);
+        AbstractTeam team = scoreboard.getTeam(teamName);
         npc.data().remove(NPC.Metadata.SCOREBOARD_FAKE_TEAM_NAME);
         if (team == null || name == null || !team.hasEntry(name)) {
             try {
                 if (team != null && team.getSize() == 0) {
                     clearClientTeams(team);
-                    team.unregister();
+                    scoreboard.removeTeam(teamName);
                 }
             } catch (IllegalStateException ex) {
             }
@@ -131,7 +131,7 @@ public void onDespawn(DespawnReason reason) {
             }
             if (team.getSize() <= 1) {
                 clearClientTeams(team);
-                team.unregister();
+                scoreboard.removeTeam(teamName);
             } else {
                 team.removeEntry(name);
             }
@@ -177,16 +177,16 @@ public void update() {
         String forceVisible = npc.data().<Object> get(NPC.Metadata.NAMEPLATE_VISIBLE, true).toString();
         boolean nameVisibility = !npc.requiresNameHologram()
                 && (forceVisible.equals("true") || forceVisible.equals("hover"));
-        Team team = getTeam();
+        AbstractTeam team = getTeam();
         if (team == null)
             return;
 
         if (!Setting.USE_SCOREBOARD_TEAMS.asBoolean()) {
             for (Player player : Bukkit.getOnlinePlayers()) {
                 metadata.remove(player.getUniqueId(), team.getName());
-                NMS.sendTeamPacket(player, team, 1);
+                team.sendToPlayer(player, AbstractTeam.SendMode.REMOVE);
             }
-            team.unregister();
+            scoreboard.removeTeam(team.getName());
             npc.data().remove(NPC.Metadata.SCOREBOARD_FAKE_TEAM_NAME);
             return;
         }
@@ -196,40 +196,26 @@ public void update() {
                     : npc.getUniqueId().toString();
         }
         if (SUPPORT_TEAM_SETOPTION) {
-            OptionStatus visibility = nameVisibility ? OptionStatus.ALWAYS : OptionStatus.NEVER;
-            if (visibility != team.getOption(Option.NAME_TAG_VISIBILITY)) {
+            AbstractTeam.NameTags visibility = nameVisibility ? AbstractTeam.NameTags.ALWAYS_SHOW : AbstractTeam.NameTags.NEVER_SHOW;
+            if (visibility != team.getNameTagVisibility()) {
                 changed = true;
             }
-            team.setOption(Option.NAME_TAG_VISIBILITY, visibility);
-        } else {
-            NMS.setTeamNameTagVisible(team, nameVisibility);
+            team.setNameTagVisibility(visibility);
         }
+
         if (SUPPORT_COLLIDABLE_SETOPTION) {
-            try {
-                OptionStatus collide = npc.data().<Boolean> get(NPC.Metadata.COLLIDABLE, !npc.isProtected())
-                        ? OptionStatus.ALWAYS
-                        : OptionStatus.NEVER;
-                if (collide != team.getOption(Option.COLLISION_RULE)) {
-                    changed = true;
-                }
-                team.setOption(Option.COLLISION_RULE, collide);
-            } catch (NoSuchMethodError e) {
-                SUPPORT_COLLIDABLE_SETOPTION = false;
-            } catch (NoClassDefFoundError e) {
-                SUPPORT_COLLIDABLE_SETOPTION = false;
+            AbstractTeam.CollisionRule collide = npc.data().<Boolean> get(NPC.Metadata.COLLIDABLE, !npc.isProtected())
+                    ? AbstractTeam.CollisionRule.ALWAYS
+                    : AbstractTeam.CollisionRule.NEVER;
+            if (collide != team.getCollisionRule()) {
+                changed = true;
             }
+            team.setCollisionRule(collide);
         }
-        if (color != null) {
-            if (SUPPORT_GLOWING_COLOR) {
-                if (team.getColor() == null || previousGlowingColor == null
-                        || previousGlowingColor != null && color != previousGlowingColor) {
-                    team.setColor(color);
-                    previousGlowingColor = color;
-                    changed = true;
-                }
-            } else if (team.getPrefix() == null || team.getPrefix().length() == 0 || previousGlowingColor == null
-                    || previousGlowingColor != null && !team.getPrefix().equals(previousGlowingColor.toString())) {
-                team.setPrefix(color.toString());
+
+        if (color != null && SUPPORT_GLOWING_COLOR) {
+            if (team.getColor() == null || previousGlowingColor == null || color != previousGlowingColor) {
+                team.setColor(color);
                 previousGlowingColor = color;
                 changed = true;
             }
@@ -241,9 +227,9 @@ public void update() {
                 continue;
 
             if (metadata.has(player.getUniqueId(), team.getName())) {
-                NMS.sendTeamPacket(player, team, 2);
+                team.sendToPlayer(player, AbstractTeam.SendMode.ADD_OR_MODIFY);
             } else {
-                NMS.sendTeamPacket(player, team, 0);
+                team.sendToPlayer(player, AbstractTeam.SendMode.ADD_OR_MODIFY);
 
                 metadata.set(player.getUniqueId(), team.getName(), true);
             }

main/src/main/java/net/citizensnpcs/trait/scoreboard/AbstractScoreboard.java

@@ -0,0 +1,29 @@
+package net.citizensnpcs.trait.scoreboard;
+
+/**
+ * Represents a scoreboard that can be used to manage teams and their entries.
+ * This is an abstraction over the underlying {@link org.bukkit.scoreboard.Scoreboard} and
+ * {@link net.megavex.scoreboardlibrary.api.team.ScoreboardTeam} objects.
+ */
+public interface AbstractScoreboard {
+
+    /**
+     * Gets a team by name.
+     * @param name Name of the team.
+     * @return Team with the given name, or null if no such team exists.
+     */
+    AbstractTeam getTeam(String name);
+
+    /**
+     * Deletes a team from this scoreboard.
+     * @param name Name of the team.
+     */
+    void removeTeam(String name);
+
+    /**
+     * Creates a new team if it does not exist.
+     * @param name Name of the team.
+     * @return Team with the given name, or the existing team if it already exists.
+     */
+    AbstractTeam createTeam(String name);
+}