Jump to content

[1.16.5] How to load and hot reload data from JSON


RisingInIris2017

Recommended Posts

To put more specifically, I expect my mod has such a behavior:

1. When Minecraft instance(both client and server) start, load some data from a JSON file.

2. Using these data to do what it should do, until vanilla `/reload` command is executed.

3. Reload new data from that JSON file.

4. Continue to do what it should do.

 

I wrote these codes in my mod's main class:

@Mod("spellbind")
public class Spellbind {

    public static final String MOD_ID = "spellbind";
    public static final String MOD_NAME = "Spellbind";
    private static final Logger LOGGER = LogManager.getLogger();

    public Spellbind() {
        final IEventBus forgeBus = MinecraftForge.EVENT_BUS;

        forgeBus.addListener(this::jsonRulesReader);
    }

    // Read JSON logic
    // Read JSON from datapack, so that modpack makers can set their own "spells".

    private void jsonRulesReader (AddReloadListenerEvent event) {
        event.addListener("something missing");
    }

Then I did find something missing. I had no idea about how to use the `AddReloadListenerEvent`.

I searched the Internet and get this: 

I tried to use the `JsonReloadListener`, but I found I did not understand it, neither.

I do read many Forge forum posts and codes(from other mods and Minecraft vanilla itself), but I still feel difficult.

You are highly appreciated if you could explain what code I should write to achieve my goal.

Thanks in advance!

 

Link to comment
Share on other sites

I found that if I `new JsonReloadListener`, I should pass two arguments to two parameters of its constructor, the first one is a `Gson`, while second one is a `String`.

I read the code of AdvancementManager, it passes `(new GsonBuilder()).create()` to the first parameter, and passes String `"advancement"` to the second one. So I wrote these codes:

    private void jsonRulesReader (AddReloadListenerEvent event) {
        event.addListener(new JsonReloadListener((new GsonBuilder()).create(), "some String") {
            @Override
            protected void apply(Map<ResourceLocation, JsonElement> objectIn, IResourceManager resourceManagerIn, IProfiler profilerIn) {
                "something need to do"
            }
        });
    }

I wonder what the second parameters mean. What will that string be? Will it become a part of a certain `ResourceLocation`, or a part of file name?

Link to comment
Share on other sites

Thanks for your kind-hearted explanation! I tried your method and now it can read JSONs from correct ResourceLocation.

private void jsonRulesReader (AddReloadListenerEvent event) {
        event.addListener(new JsonReloadListener((new GsonBuilder()).create(), "rules") {
            @Override
            protected void apply(Map<ResourceLocation, JsonElement> objectIn, IResourceManager resourceManagerIn, IProfiler profilerIn) {
                objectIn.forEach((resourceLocation, ruleJsonElement) -> {
                    try {
                        JsonObject jsonObject = JSONUtils.getJsonObject(ruleJsonElement, "rule");
                        LOGGER.warn(jsonObject);
                    } catch (IllegalArgumentException | JsonParseException e) {
                        LOGGER.error("Parsing error loading custom rules. Message: {}", e.getMessage());
                    }
                });
            }
        });
    }

But I have a new problem: it cannot reload data when I type `/reload` command.

To be more specific, I can reproduce this issue by following steps:

1. Start Minecraft and see it loading my mod's datapack.

2. After it finishes loading, modify a JSON.

3. Execute the `/reload` command.

4. In console log I find that it prints the version of JSON before it was modified.

5. Restart Minecraft, then I can see the modified JSON is loaded.

This is not the behavior I want. I need it to be reloaded everytime the `/reload` command is executed.

So how should I modify my codes to achieve that goal?

Link to comment
Share on other sites

13 minutes ago, diesieben07 said:

Resources in src/main/resources are copied into the build output folder when running the game, if you modify them while the game is running you have to rebuild.

Oh I got it. I'm using IDEA, so if I want to reload these JSONs, I have to make a datapack and put it into `/run`?

Are there some more easier ways?

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.

Guest
Unfortunately, your content contains terms that we do not allow. Please edit your content to remove the highlighted words below.
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.



  • Recently Browsing

    • No registered users viewing this page.
  • Posts

    • rp.crazyheal.xyz mods  
    • I'm developing a dimension, but it's kinda resource intensive so some times during player teleporting it lags behind making the player phase down into the void, so im trying to implement some kind of pregeneration to force the game loading a small set of chunks in the are the player will teleport to. Some of the things i've tried like using ServerLevel and ServerChunkCache methods like getChunk() dont actually trigger chunk generation if the chunk isn't already on persistent storage (already generated) or placing tickets, but that doesn't work either. Ideally i should be able to check when the task has ended too. I've peeked around some pregen engines, but they're too complex for my current understanding of the system of which I have just a basic understanding (how ServerLevel ,ServerChunkCache  and ChunkMap work) of. Any tips or other classes I should be looking into to understand how to do this correctly?
    • https://mclo.gs/4UC49Ao
    • Way back in the Forge 1.17 days, work started for adding JPMS (Java Platform Module Support) to ModLauncher and ForgeModLoader. This has been used internally by Forge and some libraries for a while now, but mods (those with mods.toml specifically) have not been able to take advantage of it. As of Forge 1.21.1 and 1.21.3, this is now possible!   What is JPMS and what does it mean for modders? JPMS is the Java Platform Module System, introduced in Java 9. It allows you to define modules, which are collections of packages and resources that can be exported or hidden from other modules. This allows for much more fine-tuned control over visibility, cleaner syntax for service declarations and support for sealed types across packages. For example, you might have a mod with a module called `com.example.mod` that exports `com.example.mod.api` and `com.example.mod.impl` to other mods, but hides `com.example.mod.internal` from them. This would allow you to have a clean API for other mods to use, while keeping your internal implementation details hidden from IDE hints, helping prevent accidental usage of internals that might break without prior notice. This is particularly useful if you'd like to use public records with module-private constructors or partially module-private record components, as you can create a sealed interface that only your record implements, having the interface be exported and the record hidden. It's also nice for declaring and using services, as you'll get compile-time errors from the Java compiler for typos and the like, rather than deferring to runtime errors. In more advanced cases, you can also have public methods that are only accessible to specific other modules -- handy if you want internal interactions between multiple of your own mods.   How do I bypass it? We understand there may be drama in implementing a system that prevents mods from accessing each other's internals when necessary (like when a mod is abandoned or you need to fix a compat issue) -- after all, we are already modding a game that doesn't have explicit support for Java mods yet. We have already thought of this and are offering APIs from day one to selectively bypass module restrictions. Let me be clear: Forge mods are not required to use JPMS. If you don't want to use it, you don't have to. The default behaviour is to have fully open, fully exported automatic modules. In Java, you can use the `Add-Opens` and `Add-Exports` manifest attributes to selectively bypass module restrictions of other mods at launch time, and we've added explicit support for these when loading your Forge mods. At compile-time, you can use existing solutions such as the extra-java-module-info Gradle plugin to deal with non-modular dependencies and add extra opens and exports to other modules. Here's an example on how to make the internal package `com.example.examplemod.internal` open to your mod in your build.gradle: tasks.named('jar', Jar) { manifest { attributes([ 'Add-Opens' : 'com.example.examplemod/com.example.examplemod.internal' 'Specification-Title' : mod_id, 'Specification-Vendor' : mod_authors // (...) ]) } } With the above in your mod's jar manifest, you can now reflectively access the classes inside that internal package. Multiple entries are separated with a space, as per Java's official spec. You can also use Add-Exports to directly call without reflection, however you'd need to use the Gradle plugin mentioned earlier to be able to compile. The syntax for Add-Exports is the same as Add-Opens, and instructions for the compile-time step with the Gradle plugin are detailed later in this post. Remember to prefer the opens and exports keywords inside module-info.java for sources you control. The Add-Opens/Add-Exports attributes are only intended for forcing open other mods.   What else is new with module support? Previously, the runtime module name was always forced to the first mod ID in your `mods.toml` file and all packages were forced fully open and exported. Module names are now distinguished from mod IDs, meaning the module name in your module-info.java can be different from the mod ID in your `mods.toml`. This allows you to have a more descriptive module name that doesn't have to be the same as your mod ID, however we strongly recommend including your mod ID as part of your module name to aid troubleshooting. The `Automatic-Module-Name` manifest attribute is now also honoured, allowing you to specify a module name for your mod without needing to create a `module-info.java` file. This is particularly useful for mods that don't care about JPMS features but want to have a more descriptive module name and easier integration with other mods that do use JPMS.   How do I use it? The first step is to create a `module-info.java` file in your mod's source directory. This file should be in the same package as your main mod class, and should look something like this: open module com.example.examplemod { requires net.minecraftforge.eventbus; requires net.minecraftforge.fmlcore; requires net.minecraftforge.forge; requires net.minecraftforge.javafmlmod; requires net.minecraftforge.mergetool.api; requires org.slf4j; requires logging; } For now, we're leaving the whole module open to reflection, which is a good starting point. When we know we want to close something off, we can remove the open modifier from the module and open or export individual packages instead. Remember that you need to be open to Forge (module name net.minecraftforge.forge), otherwise it can't call your mod's constructor. Next is fixing modules in Gradle. While Forge and Java support modules properly, Gradle does not put automatic modules on the module path by default, meaning that the logging module (from com.mojang:logging) is not found. To fix this, add the Gradle plugin and add a compile-time module definition for that Mojang library: plugins { // (...) id 'org.gradlex.extra-java-module-info' version "1.9" } // (...) extraJavaModuleInfo { failOnMissingModuleInfo = false automaticModule("com.mojang:logging", "logging") } The automatic module override specified in your build.gradle should match the runtime one to avoid errors. You can do the same for any library or mod dependency that is missing either a module-info or explicit Automatic-Module-Name, however be aware that you may need to update your mod once said library adds one. That's all you need to get started with module support in your mods. You can learn more about modules and how to use them at dev.java.
    • Faire la mise à jour grâce à ce lien m'a aider personnellement, merci à @Paint_Ninja. https://www.amd.com/en/support 
  • Topics

  • Who's Online (See full list)

    • There are no registered users currently online
×
×
  • Create New...

Important Information

By using this site, you agree to our Terms of Use.