Properly update config system to also handle per book configuration

Author: maxanier

build.gradle

@@ -45,6 +45,7 @@ dependencies {
     ])
     compileOnly fg.deobf("mezz.jei:jei-${project.minecraft_version}:${project.jei_version}:api") //API for compile
     runtimeOnly fg.deobf("mezz.jei:jei-${project.minecraft_version}:${project.jei_version}") //Full for runtime
+    //runtimeClasspath 'com.electronwill.night-config:hocon:3.6.2'
 }
 
 sourceSets {

src/main/java/amerifrance/guideapi/GuideConfig.java

@@ -1,72 +1,56 @@
 package amerifrance.guideapi;
 
 
+import amerifrance.guideapi.api.GuideAPI;
+import amerifrance.guideapi.api.impl.Book;
+import com.electronwill.nightconfig.core.CommentedConfig;
+import com.google.common.collect.Maps;
 import net.minecraftforge.common.ForgeConfigSpec;
+import net.minecraftforge.fml.ModContainer;
 import net.minecraftforge.fml.ModLoadingContext;
+import net.minecraftforge.fml.config.ConfigFileTypeHandler;
 import net.minecraftforge.fml.config.ModConfig;
 import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
 import org.apache.commons.lang3.tuple.Pair;
 
+import java.util.HashMap;
+import java.util.Map;
+
 public class GuideConfig {
-    /**
-     * Synced to clients.
-     * Only loaded on world load
-     */
-    public static final Server SERVER;
+
     /**
      * For side independent configuration. Not synced.
      * Loaded after registry events but before setup
      */
-    public static final Common COMMON;
-
-    private static final ForgeConfigSpec serverSpec;
-    private static final ForgeConfigSpec commonSpec;
-
-
-    static {
-        final Pair<Server, ForgeConfigSpec> specPair = new ForgeConfigSpec.Builder().configure(Server::new);
-        serverSpec = specPair.getRight();
-        SERVER = specPair.getLeft();
-    }
-
-    static {
-        final Pair<Common, ForgeConfigSpec> specPair = new ForgeConfigSpec.Builder().configure(Common::new);
-        commonSpec = specPair.getRight();
-        COMMON = specPair.getLeft();
-    }
-
-    public static void registerConfigs() {
-        ModLoadingContext.get().registerConfig(ModConfig.Type.COMMON, commonSpec);
-        ModLoadingContext.get().registerConfig(ModConfig.Type.SERVER, serverSpec);
-        FMLJavaModLoadingContext.get().getModEventBus().register(GuideConfig.class);
-    }
+    public static Common COMMON;
 
-    public static class Server {
+    public static class Common {
 
         public final ForgeConfigSpec.BooleanValue canSpawnWithBook;
 
-        Server(ForgeConfigSpec.Builder builder) {
-            builder.comment("Server configuration settings").push("server");
-            canSpawnWithBook = builder.comment("Allows books to spawn with new players.\nThis is a global override for all books.").define("canSpawnWithBook",true);
-            builder.pop();
-        }
-
-//        for ( Book book : GuideAPI.getBooks().values()) TODO
-//                SPAWN_BOOKS.put(book, config.getBoolean(book.getRegistryName().toString(), "Books.Spawn", book.shouldSpawnWithBook(), ""));
-//
-//        config.setCategoryComment("Books.Spawn", "If true, the user will spawn with the book.\nThis defaults to the value the book owner has set and is overridden by this config.");
-    }
-
-    public static class Common {
-
         public final ForgeConfigSpec.BooleanValue enableLogging;
+        public final Map<Book,ForgeConfigSpec.BooleanValue> SPAWN_BOOKS = new HashMap<>();
 
 
         Common(ForgeConfigSpec.Builder builder) {
             builder.comment("Common configurations settings").push("common");
             enableLogging = builder.comment("Enables extra information being printed to the console.").define("enableLogging",true);
+            canSpawnWithBook = builder.comment("Allows books to spawn with new players.\nThis is a global override for all books if set to false.").define("canSpawnWithBook",true);
+            builder.comment("If the player should spawn with this book").push("spawnBook");
+            for(Book book : GuideAPI.getBooks().values()){
+                SPAWN_BOOKS.put(book,builder.define(book.getRegistryName().getNamespace()+"-"+book.getRegistryName().getPath(),book.shouldSpawnWithBook()));
+            }
+            builder.pop();
             builder.pop();
         }
     }
 
+    public static void buildConfiguration(){
+        final Pair<Common, ForgeConfigSpec> specPair = new ForgeConfigSpec.Builder().configure(Common::new);
+        ForgeConfigSpec commonSpec = specPair.getRight();
+        COMMON = specPair.getLeft();
+        ModLoadingContext.get().registerConfig(ModConfig.Type.COMMON, commonSpec);
+        FMLJavaModLoadingContext.get().getModEventBus().register(GuideConfig.class);
+    }
+
 }

src/main/java/amerifrance/guideapi/GuideMod.java

@@ -46,6 +46,9 @@ public GuideMod(){
     }
 
     private void setup(final FMLCommonSetupEvent event){
+        if(GuideConfig.COMMON==null){
+           throw new IllegalStateException("Did not build configuration, before configuration load. Make sure to call GuideConfig#buildConfiguration during one of the registry events");
+        }
         PacketHandler.registerPackets();
     }
 

src/main/java/amerifrance/guideapi/RegistrarGuideAPI.java

@@ -31,7 +31,7 @@ public class RegistrarGuideAPI {
     @SubscribeEvent
     public static void registerItems(RegistryEvent.Register<Item> event) {
         AnnotationHandler.gatherBooks();
-
+        GuideConfig.buildConfiguration();//Build configuration now that we know all added books
         for (Book book : GuideAPI.getBooks().values()) {
             Item guideBook = new ItemGuideBook(book);
             guideBook.setRegistryName(book.getRegistryName().toString().replace(":", "-"));

src/main/java/amerifrance/guideapi/test/TestBook.java

@@ -42,7 +42,7 @@ public class TestBook implements IGuideBook {
     @Override
     public Book buildBook() {
         BookBinder binder = new BookBinder(new ResourceLocation("guideapi","test_book"));
-        binder.setAuthor("TehNut").setColor(Color.PINK).setItemName("Display Name").setHeader("Hello there").setGuideTitle("Title message").setContentProvider(this::buildContent);
+        binder.setAuthor("TehNut").setColor(Color.PINK).setItemName("Display Name").setHeader("Hello there").setGuideTitle("Title message").setSpawnWithBook().setContentProvider(this::buildContent);
         return (book = binder.build());
     }
 

src/main/java/amerifrance/guideapi/test/TestBook2.java

@@ -35,7 +35,7 @@ public class TestBook2 implements IGuideBook {
     @Override
     public Book buildBook() {
         BookBinder binder = new BookBinder(new ResourceLocation("guideapi","test_book2"));
-        binder.setAuthor("TehNut").setColor(new Color(80,50,5)).setItemName("Display Name").setHeader("Hello there").setGuideTitle("Title message").setContentProvider(this::buildContent);
+        binder.setAuthor("TehNut").setColor(new Color(80,50,5)).setItemName("Display Name").setHeader("Hello there").setSpawnWithBook().setGuideTitle("Title message").setContentProvider(this::buildContent);
 
 
 

src/main/java/amerifrance/guideapi/util/EventHandler.java

@@ -28,6 +28,7 @@
 import net.minecraftforge.api.distmarker.Dist;
 import net.minecraftforge.api.distmarker.OnlyIn;
 import net.minecraftforge.client.event.RenderGameOverlayEvent;
+import net.minecraftforge.common.ForgeConfigSpec;
 import net.minecraftforge.event.entity.EntityJoinWorldEvent;
 import net.minecraftforge.eventbus.api.SubscribeEvent;
 import net.minecraftforge.fml.common.Mod;
@@ -43,12 +44,13 @@ public static void onPlayerJoinWorld(EntityJoinWorldEvent event) {
         if (!event.getEntity().world.isRemote && event.getEntity() instanceof PlayerEntity) {
             PlayerEntity player = (PlayerEntity) event.getEntity();
             CompoundNBT tag = getModTag(player, GuideMod.ID);
-            if (GuideConfig.SERVER.canSpawnWithBook.get()) {
+            if (GuideConfig.COMMON.canSpawnWithBook.get()) {
                 for (Book book : GuideAPI.getBooks().values()) {
-                    //if (ConfigHandler.SPAWN_BOOKS.getOrDefault(book, false) && !tag.getBoolean("hasInitial" + book.getTitle())) { TODO
+                    ForgeConfigSpec.BooleanValue bookSpawnConfig = GuideConfig.COMMON.SPAWN_BOOKS.get(book);
+                    if((bookSpawnConfig==null||bookSpawnConfig.get()) && !tag.getBoolean("hasInitial" + book.getRegistryName().toString())){
                         ItemHandlerHelper.giveItemToPlayer(player, GuideAPI.getStackFromBook(book));
-                        tag.putBoolean("hasInitial" + book.getTitle(), true);
-                    //}
+                        tag.putBoolean("hasInitial" + book.getRegistryName().toString(), true);
+                    }
                 }
             }
         }