Support Folia #3277

Euphillya · 2025-10-28T18:17:55Z

Following the Citizens API update, I'm starting to propose this PR for Folia support.
Several features may not work; please report them to me if you notice any.

Environmental Test:

[02:25:58 INFO]: Checking version, please wait...
[02:25:58 INFO]: This server is running Folia version 1.21.8-6-ver/1.21.8@612d9bd (2025-09-30T14:11:15Z) (Implementing API version 1.21.8-R0.1-SNAPSHOT)
You are running the latest version
Previous version: 1.21.8-DEV-05d3e7a (MC: 1.21.8)

Admin commands:

Command: /citizens save
Command: /citizens reload (with respawn)

Test NPC Player

Test NPC mobs

Currently broken:

Scoreboard (not supported on Folia)

CLAassistant · 2025-10-28T18:18:02Z

All committers have signed the CLA.

…sommes sur le bon thread

…4Folia into support-folia

…players

Euphillya · 2025-11-08T00:13:54Z

I think the changes to make it compatible with Folia are complete. I’m no longer seeing any errors on my end, even after multiple restarts and reloads.

fullwall

I assume that async safety is not checked at all right?

fullwall · 2025-11-24T08:28:20Z

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

                    registry.saveToStore();
                }
            }
+            if (net.citizensnpcs.api.util.SpigotUtil.isFoliaServer()) {


Why is this necessary?

Because you can't "despawn" the NPCs while the server is down. But fortunately, they despawn during the shutdown.

Because you can't "despawn" the NPCs while the server is down. But fortunately, they despawn during the shutdown.

More specifically, Folia's regional threads are all shutting down during the server shutdown, so it is impossible to interact with them.

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

main/src/main/java/net/citizensnpcs/EventListen.java

fullwall · 2025-11-24T08:33:00Z

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


    @Override
    public void onDespawn(DespawnReason reason) {
+        if (net.citizensnpcs.api.util.SpigotUtil.isFoliaServer()) return; // Not Supported on Folia


https://docs.papermc.io/folia/faq/#what-commands-does-folia-disable

Scoreboards are disabled directly in Folia's CraftBukkit API because they're not safe.
So instead of constantly getting an error, we can remove it.
Later, we could add an alternative using the PDC on entities, but we'll have to see.

fullwall · 2025-11-24T08:33:38Z

main/src/main/java/net/citizensnpcs/util/ChunkCoord.java

        return world != null ? world.getChunkAt(x, z) : null;
    }

+    public World getWorld() {


Why this change?

I added it to avoid doing multiple Bukkit.getWorld calls in CitizensNavigator, but it can be removed.

fullwall · 2025-11-24T08:34:37Z

main/src/main/java/net/citizensnpcs/util/Util.java

    }

    public static <T> T callPossiblySync(Callable<T> callable, boolean sync) {
+        if (SpigotUtil.isFoliaServer()) {


Perhaps this method should be deleted then

delete callPossiblySync ?

v1_20_R4/src/main/java/net/citizensnpcs/nms/v1_20_R4/util/CitizensEntityTracker.java

fullwall · 2025-11-24T08:36:13Z

v1_20_R4/src/main/java/net/citizensnpcs/nms/v1_20_R4/util/NMSImpl.java


    @Override
    public void setLocationDirectly(org.bukkit.entity.Entity entity, Location location) {
+        // Todo temp teleport


Is there any equivalent method in folia?

I tried unsuccessfully to find a solution because the entity can leave the regional thread if it has to travel a long distance. Since this method is used during the entity's summoning, I found it more practical to teleport it for the time being.

As I said earlier, I can't restore it exactly to the way it was before, but I did this to maintain the same behavior if we're on the same ticked region:
469dcb9

v1_21_R6/src/main/java/net/citizensnpcs/nms/v1_21_R6/util/NMSImpl.java

Euphillya · 2025-11-24T16:45:25Z

I assume that async safety is not checked at all right?

I did everything I could to avoid any strange surprises due to async, but it's possible I overlooked something. However, at first glance, it seems to be working on my game server.

I will, however, make the changes you requested above.

Petite explication: Sur Folia, un déplacement d'entité effectué via snapTo déclenche une mise à jour des sections qui necessite d'être exécutée sur le thread propriétaire de la région initiale. Cependant, il est possible que ce dernier ne soit pas dans la même region initiale, de ce fait Folia rejette la demande en générant l'erreur: Cannot move entity off-main qu'on se mette sur le thread de l'entité, ou le thread de la future localisation. De ce fait, je fais une vérification au préalable si c'est le même monde et que la region tické pour l'entité et la future localisation est le même, et si c'est le cas, snapTo fonctionne, sinon il faut lancer une teleportation async. De ce fait, quand tout est réuni, je garde le fonctionnement initial, sinon on est obligé de teleporter l'entité

Ajout Folia Supported dans plugin.yml

11ee901

Euphillya added 6 commits October 28, 2025 19:18

Folia ne permet pas de supprimer les NPcs quand il s'arrête

33aa586

Replace scheduler dans Citizens.java

69127b3

Replace scheduler dans EventListen.java

67ee2c4

Replace scheduler in Metrics.java

ecb0be3

Replace scheduler dans NPCCommands.java

26a5979

Replace scheduler dans CitizensNPC.java

9873001

Euphillya changed the title ~~Ajout Folia Supported dans plugin.yml~~ [WIP] Support Folia Oct 28, 2025

Euphillya added 21 commits October 28, 2025 19:27

Replace scheduler dans Skin.java

d49c245

Replace scheduler dans SkinPacketTracker.java

303106c

Replace scheduler dans SkinUpdateTracker.java

e6be69c

Replace scheduler dans ProfileFetchThread.java

ce49c2c

Replace scheduler dans ProfileFetcher.java

20f9d91

Replace scheduler dans ProfileRequest.java

9802e10

Replace scheduler dans CommandTrait.java

4626065

Replace scheduler dans PacketNPC.java

c0f6622

Scordboard not supported on folia

b418e49

Replace scheduler dans ShopTrait.java

a8dec93

Replace scheduler dans OpenShopAction.java

6ef64b9

Replace scheduler dans GuidedWaypointProvider.java

1d77e3e

Replace scheduler dans LinearWaypointProvider.java

29659f4

Replace scheduler dans WanderWaypointProvider.java

0a19dac

Replace scheduler dans Waypoint.java

170a618

Replace scheduler dans DelayTrigger.java

740fa96

Replace scheduler dans PlayerAnimation.java

77ebfdf

Replace scheduler dans PlayerUpdateTask.java

800fbdc

callPossiblySync peut pas être appeler dans Folia

ded99e6

Ajout d'une vérification sur certaines fonctions pour savoir si nous …

f0aba2f

…sommes sur le bon thread

Replace callPossiblySync dans le NMS

1a5992e

Euphillya added 11 commits October 29, 2025 04:20

Merge branch 'CitizensDev:master' into support-folia

b3618fa

Executer une commande sur le bon thread

87759cb

Merge branch 'support-folia' of https://github.com/Euphillya/Citizens…

af87bbf

…4Folia into support-folia

Fix double appel super.updatePlayer

b571f12

Fix forceload

da25c58

Fix spawn mauvais thread pour les autres entités qui ne sont pas des …

ae453cb

…players

Merge branch 'CitizensDev:master' into support-folia

e1a3372

On ne peux pas Entity#snapTo sur Folia, on fait une teleportation

3e3b046

Resupport spigot /npc create

3178e34

Fix update ticket

415d866

COW ne permet pas de remove (UnsupportedOperationException)

a6249a7

Euphillya marked this pull request as ready for review November 8, 2025 00:13

Euphillya changed the title ~~[WIP] Support Folia~~ Support Folia Nov 8, 2025

Euphillya added 4 commits November 8, 2025 16:02

Merge branch 'CitizensDev:master' into support-folia

1792599

Merge branch 'CitizensDev:master' into support-folia

3a9004a

Merge branch 'master' into support-folia

46ebee2

Merge branch 'CitizensDev:master' into support-folia

85902de

fullwall requested changes Nov 24, 2025

View reviewed changes

Euphillya added 10 commits November 24, 2025 17:48

Enlever la lambda syntax

dbfc5a1

Fix upstream

64ad032

Mettre en import SchedulerRunnable

5e5954b

Changer cancelledUpdatePlayer en cancellableUpdatePlayer

df155cd

Cache method handled

1604d7b

Merge branch 'master' into support-folia

234e80f

Fix update upstream

60bbf5f

enlever le commentaire todo

cff0682

Merge branch 'CitizensDev:master' into support-folia

caab819

Uh oh!

Support Folia #3277

Are you sure you want to change the base?

Support Folia #3277

Uh oh!

Conversation

Euphillya commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Environmental Test:

Admin commands:

Test NPC Player

Test NPC mobs

Currently broken:

Uh oh!

CLAassistant commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Euphillya commented Nov 8, 2025

Uh oh!

fullwall left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Euphillya commented Nov 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Euphillya commented Oct 28, 2025 •

edited

Loading

CLAassistant commented Oct 28, 2025 •

edited

Loading