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.
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

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

onebeastchris · 2024-09-23T06:08:56Z

...rap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeePlugin.java

    @SuppressWarnings("BooleanMethodIsAlwaysInverted")
    private boolean loadConfig() {
-        try {
-            if (!getDataFolder().exists()) //noinspection ResultOfMethodCallIgnored
-                getDataFolder().mkdir();
-            File configFile = FileUtils.fileOrCopiedFromResource(new File(getDataFolder(), "config.yml"),
-                    "config.yml", (x) -> x.replaceAll("generateduuid", UUID.randomUUID().toString()), this);
-            this.geyserConfig = FileUtils.loadConfig(configFile, GeyserBungeeConfiguration.class);
-        } catch (IOException ex) {
-            geyserLogger.error(GeyserLocale.getLocaleStringLog("geyser.config.failed"), ex);
-            ex.printStackTrace();
-            return false;
-        }
-        return true;
+        this.geyserConfig = new ConfigLoader(this).createFolder().load(GeyserPluginConfig.class);
+        return this.geyserConfig != null;
    }
 }


Maybe it's worth it to make this a default method in GeyserBootstrap - it's currently duplicated in every bootstrap impl

bootstrap/mod/fabric/build.gradle.kts

...p/mod/src/main/java/org/geysermc/geyser/platform/mod/mixin/client/IntegratedServerMixin.java

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

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

onebeastchris · 2024-09-23T06:48:46Z

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

+    }
+
+    private AdvancedConfig migrateToAdvancedConfig(File file, ConfigurationNode configRoot) throws IOException {
+        Stream<NodePath> copyFromOldConfig = Stream.of("max-visible-custom-skulls", "custom-skull-render-distance", "scoreboard-packet-threshold", "mtu",


Other options that may be worth moving:

compression level

forward-player-ping

maybe debug-mode (and then with e.g. scoreboard/pack length warnings that are currently system properties being added there too?)

Maybe as hidden options that are not present by default: cookies, packet limit, threads

Debug mode was intentionally kept in config.yml by me because we use it when debugging with users sometimes. Can be up for discussion though.

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

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

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

…ure/configurate

Co-authored-by: chris <[email protected]>

into feature/configurate

Co-authored-by: chris <[email protected]>

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

Konicai · 2024-09-26T02:09:27Z

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

+    default boolean disableRelocateCheck() {
+        PlatformType platformType = GeyserImpl.getInstance().platformType();
+        return platformType == PlatformType.FABRIC ||
+            platformType == PlatformType.NEOFORGE ||
+            platformType == PlatformType.STANDALONE;


comment about using JIJ on modded, and not doing relocations on standalone?

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

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

+
+        // Sorry Konicai...
+        forAllConfigs(type -> {


comment can be removed now haha

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.

Konicai · 2024-09-26T05:00:38Z

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

+    private Path floodgateKeyPath;
+
+    public void loadFloodgate(Path floodgateDataFolder) {
+        floodgateKeyPath = FloodgateKeyLoader.getKeyPath(geyserConfig, floodgateDataFolder, dataFolder, geyserLogger);
+    }
+
+    @Override
+    public Path getFloodgateKeyPath() {
+        return floodgateKeyPath;
+    }


why isn't the FloodgateKeyPath just calling FloodgateKeyLoader, like other implementations? and why is testFloodgatePluginPresent the one responsible for calling this loadFloodgate method (seems like it was like that before tho)?

As long as it works, I'm not too concerned, as it will be yeeted sometime in the short term.

Co-authored-by: Konicai <[email protected]>

…ll figure it out

onebeastchris · 2024-09-26T18:41:59Z

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

+    // MinecraftAuth
+    maven("https://maven.lenni0451.net/snapshots")
+


can be removed again, we're back to release

…ure/configurate

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 added 8 commits September 9, 2024 20:07

Let annotations work

a6c21b1

Renaming to PluginSpecific

b719278

Use global bStats config where possible

1271505

Fix test

e99759d

Re-introduce asterisk behavior in configs

5551169

Remove GeyserPluginBootstrap as it's no longer necessary

45f8baf

Remove old config.yml file

adee6a7

Update Xbox achievement comment

869f7a8

onebeastchris reviewed Sep 23, 2024

View reviewed changes

Camotoy and others added 9 commits September 23, 2024 12:45

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

2034ffa

…ure/configurate

Apply suggestions from code review

3448c2f

Co-authored-by: chris <[email protected]>

Merge branch 'feature/configurate' of https://github.com/GeyserMC/Geyser

d03e661

into feature/configurate

No need to remove values anymore

2ee488d

Fix: disable bstats relocation on platforms where it is not needed

a44edb3

ensure it builds

02a361e

Update custom unavailable slot comment

0d9b20a

Co-authored-by: chris <[email protected]>

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 <[email protected]>

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch config system to Configurate #5010

Switch config system to Configurate #5010

Camotoy commented Aug 31, 2024 •

edited

Loading

onebeastchris Sep 23, 2024

onebeastchris Sep 23, 2024

Camotoy Sep 23, 2024

Konicai left a comment

Konicai Sep 26, 2024

Konicai Sep 26, 2024

Konicai Sep 26, 2024

Camotoy Sep 26, 2024

Konicai Sep 26, 2024

Camotoy Sep 26, 2024

onebeastchris Sep 26, 2024

		// MinecraftAuth
		maven("https://maven.lenni0451.net/snapshots")

Switch config system to Configurate #5010

Are you sure you want to change the base?

Switch config system to Configurate #5010

Conversation

Camotoy commented Aug 31, 2024 • edited Loading

User-facing changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Konicai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Camotoy commented Aug 31, 2024 •

edited

Loading