Switch config system to Configurate #5010

Camotoy · 2024-08-31T18:25:34Z

The primary goal of this PR is to facilitate config changes required for the Floodgate merge, while also allowing for automatic config file generation and updates, as well as customizing configs depending on the features available to a platform.

We have also decided to remove usage of the Jackson library within Geyser. While it has its benefits over Gson, ultimately all platforms have Gson access (and our libraries utilize Gson alongside that) and Jackson is a hefty dependency to shade within Geyser.

User-facing changes

The config file is split into two files - config.yml and config-advanced.yml (name subject to change to something that will always place it below config.yml alphabetically). The primary config will consist of values that a typical user needs to change for a typical setup or other basic config values. The advanced config will consist of values that we don't want most users to change, while still being accessible to tech-savvy users. This will be done at a later date.
The ultimate goal is to keep setup super-simple while still allowing Geyser to be customizable.

Metrics config options are now moved to platform global configs, if they currently exist.

…ure/configurate

…ment moving

…ure/configurate

Improve node ordering when updating configs

bootstrap/bungeecord/build.gradle.kts

bootstrap/spigot/build.gradle.kts

core/src/main/java/org/geysermc/geyser/configuration/GeyserConfig.java

…ure/configurate

Co-authored-by: chris <github@onechris.mozmail.com>

Konicai

14 files left that are more closely related to config loading. can probably get to those on friday

core/src/main/java/org/geysermc/geyser/GeyserBootstrap.java

core/src/main/java/org/geysermc/geyser/util/metrics/MetricsPlatform.java

core/src/test/java/org/geysermc/geyser/configuration/ConfigLoaderTest.java

core/src/main/java/org/geysermc/geyser/text/GeyserLocale.java

core/src/main/java/org/geysermc/geyser/text/AsteriskSerializer.java

Konicai · 2024-09-26T02:38:57Z

core/src/main/java/org/geysermc/geyser/dump/DumpInfo.java

+        try {
+            // Workaround for JsonAdapter not being allowed on methods
+            ConfigurationOptions options = InterfaceDefaultOptions.addTo(ConfigurationOptions.defaults(), builder ->
+                    builder.addProcessor(AsteriskSerializer.Asterisk.class, String.class, AsteriskSerializer.CONFIGURATE_SERIALIZER))
+                .shouldCopyDefaults(false);
+
+            ConfigurationNode configNode = CommentedConfigurationNode.root(options);
+            configNode.set(geyser.config());
+            this.config = configNode.get(geyser.config().getClass());
+
+            ConfigurationNode advancedConfigNode = CommentedConfigurationNode.root(options);
+            advancedConfigNode.set(geyser.config().advanced());
+            this.advancedConfig = advancedConfigNode.get(AdvancedConfig.class);
+        } catch (SerializationException e) {
+            if (geyser.config().debugMode()) {
+                e.printStackTrace();
+            }
+        }


Can we use configurate-gson instead? Should only increase jar size by 6 classes at first glance

I did attempt that once... I think I can try again.

bootstrap/mod/src/main/java/org/geysermc/geyser/platform/mod/GeyserModBootstrap.java

Co-authored-by: Konicai <71294714+Konicai@users.noreply.github.com>

…ll figure it out

build-logic/src/main/kotlin/geyser.base-conventions.gradle.kts

…ure/configurate

# Conflicts: # bootstrap/spigot/src/main/java/org/geysermc/geyser/platform/spigot/GeyserSpigotInjector.java # bootstrap/standalone/src/main/java/org/geysermc/geyser/platform/standalone/GeyserStandaloneBootstrap.java # bootstrap/standalone/src/main/java/org/geysermc/geyser/platform/standalone/GeyserStandaloneLogger.java # bootstrap/viaproxy/src/main/java/org/geysermc/geyser/platform/viaproxy/GeyserViaProxyPlugin.java # core/src/main/java/org/geysermc/geyser/GeyserImpl.java # core/src/main/java/org/geysermc/geyser/network/UpstreamPacketHandler.java # core/src/main/java/org/geysermc/geyser/registry/populator/BlockRegistryPopulator.java # core/src/main/java/org/geysermc/geyser/registry/populator/CreativeItemRegistryPopulator.java # core/src/main/java/org/geysermc/geyser/registry/type/GeyserMappingItem.java # core/src/main/java/org/geysermc/geyser/session/GeyserSession.java # core/src/main/resources/mappings

# Conflicts: # bootstrap/viaproxy/src/main/java/org/geysermc/geyser/platform/viaproxy/GeyserViaProxyLogger.java # build-logic/src/main/kotlin/geyser.base-conventions.gradle.kts # core/src/main/java/org/geysermc/geyser/network/UpstreamPacketHandler.java # core/src/main/java/org/geysermc/geyser/pack/GeyserResourcePackManifest.java # core/src/main/java/org/geysermc/geyser/registry/loader/SoundRegistryLoader.java # core/src/main/java/org/geysermc/geyser/util/WebUtils.java # gradle/libs.versions.toml

…ment

* Add and rename some config options, add section notes * adjust message * Update core/src/main/java/org/geysermc/geyser/command/defaults/ConnectionTestCommand.java Co-authored-by: Eclipse <eclipse@eclipseisoffline.xyz> * Update core/src/main/java/org/geysermc/geyser/configuration/GeyserConfig.java Co-authored-by: Eclipse <eclipse@eclipseisoffline.xyz> * Update ConfigLoader.java * Update AdvancedConfig.java * clarify that we're talking about the HAProxy protocol * rename config option to use-haproxy-protocol * remove ominous warning sign on xbox auth warning * adjust wording --------- Co-authored-by: Eclipse <eclipse@eclipseisoffline.xyz>

# Conflicts: # bootstrap/bungeecord/build.gradle.kts # bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeePlugin.java # bootstrap/mod/neoforge/build.gradle.kts # bootstrap/spigot/build.gradle.kts # bootstrap/velocity/build.gradle.kts # bootstrap/velocity/src/main/java/org/geysermc/geyser/platform/velocity/GeyserVelocityInjector.java # bootstrap/velocity/src/main/java/org/geysermc/geyser/platform/velocity/GeyserVelocityPlugin.java # core/src/main/java/org/geysermc/geyser/GeyserImpl.java # core/src/main/java/org/geysermc/geyser/command/CommandRegistry.java # core/src/main/java/org/geysermc/geyser/command/defaults/DumpCommand.java # core/src/main/java/org/geysermc/geyser/command/defaults/VersionCommand.java # core/src/main/java/org/geysermc/geyser/dump/DumpInfo.java # core/src/main/java/org/geysermc/geyser/network/UpstreamPacketHandler.java # core/src/main/java/org/geysermc/geyser/network/netty/GeyserServer.java # core/src/main/java/org/geysermc/geyser/registry/populator/BlockRegistryPopulator.java # core/src/main/java/org/geysermc/geyser/session/GeyserSessionAdapter.java # core/src/main/java/org/geysermc/geyser/skin/SkinManager.java # core/src/main/java/org/geysermc/geyser/translator/protocol/bedrock/BedrockCommandRequestTranslator.java # core/src/main/java/org/geysermc/geyser/util/LoginEncryptionUtils.java # core/src/main/java/org/geysermc/geyser/util/WebUtils.java # gradle/libs.versions.toml

onebeastchris

LGTM, let's get this merged!

...strap/viaproxy/src/main/java/org/geysermc/geyser/platform/viaproxy/GeyserViaProxyPlugin.java

core/src/main/java/org/geysermc/geyser/GeyserImpl.java

onebeastchris · 2025-08-26T15:01:43Z

...va/org/geysermc/geyser/translator/protocol/bedrock/entity/player/BedrockEmoteTranslator.java

-        if (session.getGeyser().getConfig().getEmoteOffhandWorkaround() != EmoteOffhandWorkaroundOption.DISABLED) {
-            // Activate the workaround - we should trigger the offhand now
-            session.requestOffhandSwap();
-
-            if (session.getGeyser().getConfig().getEmoteOffhandWorkaround() == EmoteOffhandWorkaroundOption.NO_EMOTES) {
-                return;
-            }
-        }
-


are we sure we want to yeet this? if yes, we should make an official replacement

# Conflicts: # bootstrap/mod/neoforge/build.gradle.kts # bootstrap/mod/src/main/java/org/geysermc/geyser/platform/mod/GeyserModBootstrap.java # core/src/main/java/org/geysermc/geyser/GeyserImpl.java # core/src/main/java/org/geysermc/geyser/skin/SkinManager.java # core/src/main/java/org/geysermc/geyser/skin/SkinProvider.java

Camotoy and others added 25 commits May 23, 2024 19:57

Start implementing Configurate config system

25e7deb

Merge branch 'master' of https://github.com/GeyserMC/Geyser into feat…

dedb592

…ure/configurate

More development

a135d3c

Start migrating to Gson only

25a755f

Merge branch 'master' of https://github.com/GeyserMC/Geyser into feat…

10bf4ee

…ure/configurate

Progress

cb4c5ad

Merge branch 'master' of https://github.com/GeyserMC/Geyser into feat…

528de86

…ure/configurate

Update usage of WebUtils

8d24891

Most things now use Gson for JSON

2d33cfd

Allow tests to succeed by using new Gson version

0dadbc2

Use slightly cleaner version for Version deserializer

7eb5b53

Work around older Gson versions without record support

360350d

GeyserCustomSkullConfiguration uses Configurate

add02ca

Fix regression in properties get

db9b951

New config used in core

29f8e29

The configuration is gone. Long live the config.

c095c27

More changes and migrations away from Jackson

ab4cc97

Improve node ordering when updating configs

76ca326

typo

0952f79

Better check for ignoring non-configurate configs for considering com…

e506c14

…ment moving

Merge branch 'master' of https://github.com/GeyserMC/Geyser into feat…

f7a677e

…ure/configurate

Merge pull request #4954 from Konicai/feature/configurate

85d63de

Improve node ordering when updating configs

Ensure metrics UUID is valid

d9d78cd

Initial advanced config

f113c89

Remove Jackson; finish config value placements

5870856

Camotoy commented Aug 31, 2024

View reviewed changes

bootstrap/bungeecord/build.gradle.kts Outdated Show resolved Hide resolved

Camotoy commented Aug 31, 2024

View reviewed changes

bootstrap/spigot/build.gradle.kts Outdated Show resolved Hide resolved

Camotoy commented Aug 31, 2024

View reviewed changes

core/src/main/java/org/geysermc/geyser/configuration/GeyserConfig.java Outdated Show resolved Hide resolved

Camotoy added 2 commits September 1, 2024 14:45

Merge branch 'master' of https://github.com/GeyserMC/Geyser into feat…

c4c8808

…ure/configurate

Remove duplicate relocate declarations

f40cbca

Camotoy and others added 3 commits September 24, 2024 11:53

Update custom unavailable slot comment

0d9b20a

Co-authored-by: chris <github@onechris.mozmail.com>

Update cooldown image

bfd032d

Logger message for direct-compression still being enabled

fc10ec2

Camotoy added the PR: Needs Testing When a PR needs testing but is currently not under review label Sep 25, 2024

Camotoy added 2 commits September 25, 2024 19:18

Merge branch 'master' into feature/configurate

f42ee7d

oops

8b43498

Konicai linked an issue Sep 26, 2024 that may be closed by this pull request

Expired Discord CDN links #5054

Open

Konicai reviewed Sep 26, 2024

View reviewed changes

Camotoy and others added 3 commits September 26, 2024 01:07

More explicit RuntimeException message

0a62562

Co-authored-by: Konicai <71294714+Konicai@users.noreply.github.com>

Constant for 'system' locale

c4bed65

Better config JSON encoding (something is broken with Cloudflare; we'…

b2ea579

…ll figure it out

onebeastchris reviewed Sep 27, 2024

View reviewed changes

build-logic/src/main/kotlin/geyser.base-conventions.gradle.kts Outdated Show resolved Hide resolved

Camotoy added 3 commits October 8, 2024 18:44

Fix broadcast port default

c427630

Merge branch 'master' of https://github.com/GeyserMC/Geyser into feat…

6c5c451

…ure/configurate

Add this file too

8b51883

onebeastchris linked an issue Jan 29, 2025 that may be closed by this pull request

Per-Platform Configuration Options #2291

Open

eclipseisoffline mentioned this pull request Feb 23, 2025

show-cooldown example image missing #5365

Closed

onebeastchris and others added 9 commits February 27, 2025 19:31

Update configurate branch

cd44789

fix build

32ada15

Fix: Allow using custom config file on Standalone, add relocation com…

7b55ade

…ment

Move config loading to GeyserBootstrap interface

20e02b9

Back to one config file

50588b5

onebeastchris approved these changes Aug 26, 2025

View reviewed changes

Some minor touchups

1761aeb

eclipseisoffline referenced this pull request Sep 3, 2025

Config: elaborate on show-cooldown

d1afb81

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Switch config system to Configurate #5010

Switch config system to Configurate #5010

Uh oh!

Camotoy commented Aug 31, 2024 •

edited by onebeastchris

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Konicai left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Konicai Sep 26, 2024

Uh oh!

Camotoy Sep 26, 2024

Uh oh!

Uh oh!

Uh oh!

onebeastchris left a comment

Uh oh!

Uh oh!

Uh oh!

onebeastchris Aug 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Switch config system to Configurate #5010

Are you sure you want to change the base?

Switch config system to Configurate #5010

Uh oh!

Conversation

Camotoy commented Aug 31, 2024 • edited by onebeastchris Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User-facing changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Konicai left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Konicai Sep 26, 2024

Choose a reason for hiding this comment

Uh oh!

Camotoy Sep 26, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

onebeastchris left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

onebeastchris Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Camotoy commented Aug 31, 2024 •

edited by onebeastchris

Loading