Switch config system to Configurate

bootstrap/bungeecord/build.gradle.kts

@@ -12,12 +12,13 @@ dependencies {
 }
 
 platformRelocate("net.md_5.bungee.jni")
-platformRelocate("com.fasterxml.jackson")
 platformRelocate("io.netty.channel.kqueue") // This is not used because relocating breaks natives, but we must include it or else we get ClassDefNotFound
 platformRelocate("net.kyori")
 platformRelocate("org.incendo")
-platformRelocate("io.leangen.geantyref") // provided by cloud, should also be relocated
+platformRelocate("io.leangen.geantyref") // provided by cloud and Configurate, should also be relocated
 platformRelocate("org.yaml") // Broken as of 1.20
+platformRelocate("org.spongepowered")
+platformRelocate("org.bstats")
 
 // These dependencies are already present on the platform
 provided(libs.bungeecord.proxy)

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/BungeeMetrics.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2024 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.geyser.platform.bungeecord;
+
+import net.md_5.bungee.api.plugin.Plugin;
+import net.md_5.bungee.config.Configuration;
+import net.md_5.bungee.config.ConfigurationProvider;
+import net.md_5.bungee.config.YamlConfiguration;
+import org.geysermc.geyser.util.metrics.MetricsPlatform;
+
+import java.io.BufferedWriter;
+import java.io.File;
+import java.io.FileWriter;
+import java.io.IOException;
+import java.util.UUID;
+
+public final class BungeeMetrics implements MetricsPlatform {
+ private final Configuration configuration;
+
+ public BungeeMetrics(Plugin plugin) throws IOException {
+ // https://github.com/Bastian/bstats-metrics/blob/master/bungeecord/src/main/java/org/bstats/bungeecord/Metrics.java
+ File bStatsFolder = new File(plugin.getDataFolder().getParentFile(), "bStats");
+ //noinspection ResultOfMethodCallIgnored
+ bStatsFolder.mkdirs();
+ File configFile = new File(bStatsFolder, "config.yml");
+ if (!configFile.exists()) {
+ writeFile(configFile,
+ "# bStats (https://bStats.org) collects some basic information for plugin authors, like how",
+ "# many people use their plugin and their total player count. It's recommended to keep bStats",
+ "# enabled, but if you're not comfortable with this, you can turn this setting off. There is no",
+ "# performance penalty associated with having metrics enabled, and data sent to bStats is fully",
+ "# anonymous.",
+ "enabled: true",
+ "serverUuid: \"" + UUID.randomUUID() + "\"",
+ "logFailedRequests: false",
+ "logSentData: false",
+ "logResponseStatusText: false");
+ }
+
+ this.configuration = ConfigurationProvider.getProvider(YamlConfiguration.class).load(configFile);
+ }
+
+ @Override
+ public boolean enabled() {
+ return configuration.getBoolean("enabled", true);
+ }
+
+ @Override
+ public String serverUuid() {
+ return configuration.getString("serverUuid");
+ }
+
+ @Override
+ public boolean logFailedRequests() {
+ return configuration.getBoolean("logFailedRequests", false);
+ }
+
+ @Override
+ public boolean logSentData() {
+ return configuration.getBoolean("logSentData", false);
+ }
+
+ @Override
+ public boolean logResponseStatusText() {
+ return configuration.getBoolean("logResponseStatusText", false);
+ }
+
+ private void writeFile(File file, String... lines) throws IOException {
+ try (BufferedWriter bufferedWriter = new BufferedWriter(new FileWriter(file))) {
+ for (String line : lines) {
+ bufferedWriter.write(line);
+ bufferedWriter.newLine();
+ }
+ }
+ }
+}

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeeInjector.java

@@ -108,7 +108,7 @@ protected void initializeLocalChannel0(GeyserBootstrap bootstrap) throws Excepti
  listenerInfo.isPingPassthrough(),
  listenerInfo.getQueryPort(),
  listenerInfo.isQueryEnabled(),
- bootstrap.getGeyserConfig().getRemote().isUseProxyProtocol() // If Geyser is expecting HAProxy, so should the Bungee end
+ bootstrap.config().java().useProxyProtocol() // If Geyser is expecting HAProxy, so should the Bungee end
  );
 
  // The field that stores all listeners in BungeeCord
@@ -142,7 +142,7 @@ protected void initChannel(@NonNull Channel ch) throws Exception {
  }
  initChannel.invoke(channelInitializer, ch);
 
- if (bootstrap.getGeyserConfig().isDisableCompression()) {
+ if (bootstrap.config().advanced().disableCompression()) {
  ch.pipeline().addAfter(PipelineUtils.PACKET_ENCODER, "geyser-compression-disabler",
  new GeyserBungeeCompressionDisabler());
  }

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeePingPassthrough.java

@@ -67,7 +67,7 @@ public GeyserPingInfo getPingInformation(InetSocketAddress inetSocketAddress) {
  try {
  event = future.get(100, TimeUnit.MILLISECONDS);
  } catch (Throwable cause) {
- String address = GeyserImpl.getInstance().getConfig().isLogPlayerIpAddresses() ? inetSocketAddress.toString() : "<IP address withheld>";
+ String address = GeyserImpl.getInstance().config().logPlayerIpAddresses() ? inetSocketAddress.toString() : "<IP address withheld>";
  GeyserImpl.getInstance().getLogger().error("Failed to get ping information for " + address, cause);
  return null;
  }

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

@@ -33,24 +33,25 @@
 import net.md_5.bungee.protocol.ProtocolConstants;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.geysermc.geyser.FloodgateKeyLoader;
 import org.geysermc.geyser.GeyserBootstrap;
 import org.geysermc.geyser.GeyserImpl;
 import org.geysermc.geyser.api.util.PlatformType;
 import org.geysermc.geyser.command.CommandRegistry;
 import org.geysermc.geyser.command.CommandSourceConverter;
 import org.geysermc.geyser.command.GeyserCommandSource;
-import org.geysermc.geyser.configuration.GeyserConfiguration;
+import org.geysermc.geyser.configuration.ConfigLoader;
+import org.geysermc.geyser.configuration.GeyserPluginConfig;
 import org.geysermc.geyser.dump.BootstrapDumpInfo;
 import org.geysermc.geyser.ping.GeyserLegacyPingPassthrough;
 import org.geysermc.geyser.ping.IGeyserPingPassthrough;
 import org.geysermc.geyser.platform.bungeecord.command.BungeeCommandSource;
 import org.geysermc.geyser.text.GeyserLocale;
-import org.geysermc.geyser.util.FileUtils;
+import org.geysermc.geyser.util.metrics.MetricsPlatform;
 import org.incendo.cloud.CommandManager;
 import org.incendo.cloud.bungee.BungeeCommandManager;
 import org.incendo.cloud.execution.ExecutionCoordinator;
 
-import java.io.File;
 import java.io.IOException;
 import java.lang.reflect.Field;
 import java.net.InetSocketAddress;
@@ -59,13 +60,12 @@
 import java.nio.file.Paths;
 import java.util.Collection;
 import java.util.Optional;
-import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 
 public class GeyserBungeePlugin extends Plugin implements GeyserBootstrap {
 
  private CommandRegistry commandRegistry;
- private GeyserBungeeConfiguration geyserConfig;
+ private GeyserPluginConfig geyserConfig;
  private GeyserBungeeInjector geyserInjector;
  private final GeyserBungeeLogger geyserLogger = new GeyserBungeeLogger(getLogger());
  private IGeyserPingPassthrough geyserBungeePingPassthrough;
@@ -97,9 +97,7 @@ public void onGeyserInitialize() {
  if (!this.loadConfig()) {
  return;
  }
- this.geyserLogger.setDebug(geyserConfig.isDebugMode());
- GeyserConfiguration.checkGeyserConfiguration(geyserConfig, geyserLogger);
- this.geyser = GeyserImpl.load(PlatformType.BUNGEECORD, this);
+ this.geyser = GeyserImpl.load(this);
  this.geyserInjector = new GeyserBungeeInjector(this);
 
  // Registration of listeners occurs only once
@@ -163,13 +161,11 @@ public void onGeyserEnable() {
  if (!loadConfig()) {
  return;
  }
- this.geyserLogger.setDebug(geyserConfig.isDebugMode());
- GeyserConfiguration.checkGeyserConfiguration(geyserConfig, geyserLogger);
  }
 
  // Force-disable query if enabled, or else Geyser won't enable
  for (ListenerInfo info : getProxy().getConfig().getListeners()) {
- if (info.isQueryEnabled() && info.getQueryPort() == geyserConfig.getBedrock().port()) {
+ if (info.isQueryEnabled() && info.getQueryPort() == geyserConfig.bedrock().port()) {
  try {
  Field queryField = ListenerInfo.class.getDeclaredField("queryEnabled");
  queryField.setAccessible(true);
@@ -187,7 +183,7 @@ public void onGeyserEnable() {
 
  GeyserImpl.start();
 
- if (geyserConfig.isLegacyPingPassthrough()) {
+ if (!geyserConfig.integratedPingPassthrough()) {
  this.geyserBungeePingPassthrough = GeyserLegacyPingPassthrough.init(geyser);
  } else {
  this.geyserBungeePingPassthrough = new GeyserBungeePingPassthrough(getProxy());
@@ -224,8 +220,13 @@ public void onDisable() {
  }
 
  @Override
- public GeyserBungeeConfiguration getGeyserConfig() {
- return geyserConfig;
+ public PlatformType platformType() {
+ return PlatformType.BUNGEECORD;
+ }
+
+ @Override
+ public GeyserPluginConfig config() {
+ return this.geyserConfig;
  }
 
  @Override
@@ -277,11 +278,29 @@ public int getServerPort() {
 
  @Override
  public boolean testFloodgatePluginPresent() {
- if (getProxy().getPluginManager().getPlugin("floodgate") != null) {
- geyserConfig.loadFloodgate(this);
- return true;
+ return getProxy().getPluginManager().getPlugin("floodgate") != null;
+ }
+
+ @Override
+ public Path getFloodgateKeyPath() {
+ Plugin floodgate = getProxy().getPluginManager().getPlugin("floodgate");
+ Path geyserDataFolder = getDataFolder().toPath();
+ Path floodgateDataFolder = floodgate != null ? floodgate.getDataFolder().toPath() : null;
+
+ return FloodgateKeyLoader.getKeyPath(geyserConfig, floodgateDataFolder, geyserDataFolder, geyserLogger);
+ }
+
+ @Override
+ public MetricsPlatform createMetricsPlatform() {
+ try {
+ return new BungeeMetrics(this);
+ } catch (IOException e) {
+ this.geyserLogger.debug("Integrated bStats support failed to load.");
+ if (this.config().debugMode()) {
+ e.printStackTrace();
+ }
+ return null;
  }
- return false;
  }
 
  private Optional<InetSocketAddress> findCompatibleListener() {
@@ -293,17 +312,7 @@ private Optional<InetSocketAddress> findCompatibleListener() {
 
  @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;
  }
 }

bootstrap/bungeecord/src/main/java/org/geysermc/geyser/platform/bungeecord/GeyserBungeeUpdateListener.java

@@ -38,7 +38,7 @@ public final class GeyserBungeeUpdateListener implements Listener {
 
  @EventHandler
  public void onPlayerJoin(final PostLoginEvent event) {
- if (GeyserImpl.getInstance().getConfig().isNotifyOnNewBedrockUpdate()) {
+ if (GeyserImpl.getInstance().config().notifyOnNewBedrockUpdate()) {
  final ProxiedPlayer player = event.getPlayer();
  if (player.hasPermission(Permissions.CHECK_UPDATE)) {
  VersionCheckUtils.checkForGeyserUpdate(() -> new BungeeCommandSource(player));

bootstrap/mod/fabric/build.gradle.kts

@@ -21,7 +21,7 @@ dependencies {
  shadow(projects.core) { isTransitive = false }
  includeTransitive(projects.core)
 
- // These are NOT transitively included, and instead shadowed + relocated.
+ // These are NOT transitively included, and instead shadowed (+ relocated, if not under the org.geyser namespace).
  // Avoids fabric complaining about non-SemVer versioning
  shadow(libs.protocol.connection) { isTransitive = false }
  shadow(libs.protocol.common) { isTransitive = false }
@@ -46,7 +46,6 @@ tasks.withType<Jar> {
 
 relocate("org.cloudburstmc.netty")
 relocate("org.cloudburstmc.protocol")
-relocate("com.github.steveice10.mc.auth")
 
 tasks {
  remapJar {

bootstrap/mod/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricDumpInfo.java

@@ -25,6 +25,7 @@
 
 package org.geysermc.geyser.platform.fabric;
 
+import com.google.gson.annotations.JsonAdapter;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import net.fabricmc.api.EnvType;
@@ -48,7 +49,7 @@ public class GeyserFabricDumpInfo extends BootstrapDumpInfo {
  private final String minecraftVersion;
  private final EnvType environmentType;
 
- @AsteriskSerializer.Asterisk(isIp = true)
+ @JsonAdapter(value = AsteriskSerializer.class)
  private final String serverIP;
  private final int serverPort;
  private final boolean onlineMode;

bootstrap/mod/fabric/src/main/java/org/geysermc/geyser/platform/fabric/GeyserFabricPlatform.java

@@ -73,7 +73,7 @@ public boolean testFloodgatePluginPresent(@NonNull GeyserModBootstrap bootstrap)
  Optional<ModContainer> floodgate = FabricLoader.getInstance().getModContainer("floodgate");
  if (floodgate.isPresent()) {
  Path floodgateDataFolder = FabricLoader.getInstance().getConfigDir().resolve("floodgate");
- bootstrap.getGeyserConfig().loadFloodgate(bootstrap, floodgateDataFolder);
+ bootstrap.loadFloodgate(floodgateDataFolder);
  return true;
  }
 

bootstrap/mod/neoforge/src/main/java/org/geysermc/geyser/platform/neoforge/GeyserNeoForgeDumpInfo.java

@@ -25,6 +25,7 @@
 
 package org.geysermc.geyser.platform.neoforge;
 
+import com.google.gson.annotations.JsonAdapter;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import net.minecraft.server.MinecraftServer;
@@ -47,7 +48,7 @@ public class GeyserNeoForgeDumpInfo extends BootstrapDumpInfo {
  private final String minecraftVersion;
  private final Dist dist;
 
- @AsteriskSerializer.Asterisk(isIp = true)
+ @JsonAdapter(value = AsteriskSerializer.class)
  private final String serverIP;
  private final int serverPort;
  private final boolean onlineMode;
@@ -81,4 +82,4 @@ public static class ModInfo {
  public String version;
  public String url;
  }
-}
+}

bootstrap/mod/neoforge/src/main/java/org/geysermc/geyser/platform/neoforge/GeyserNeoForgePlatform.java

@@ -73,7 +73,7 @@ public GeyserNeoForgePlatform(ModContainer container) {
  public boolean testFloodgatePluginPresent(@NonNull GeyserModBootstrap bootstrap) {
  if (ModList.get().isLoaded("floodgate")) {
  Path floodgateDataFolder = FMLPaths.CONFIGDIR.get().resolve("floodgate");
- bootstrap.getGeyserConfig().loadFloodgate(bootstrap, floodgateDataFolder);
+ bootstrap.loadFloodgate(floodgateDataFolder);
  return true;
  }
  return false;