[Java] Erstellen wir einen Minecraft Mod 1.14.4 [0. Basisdatei]

(Dieser Artikel gehört zu einer Reihe von Kommentaren)

Erster Artikel: Einführung Vorheriger Artikel: Einführung Nächster Artikel: 1. Elemente hinzufügen

Basisdatei

Die Entwicklungsumgebung ist fertig und wir sind endlich am Start. Bereiten wir uns von nun an darauf vor, dass Sie mit Modding fortfahren. Ich denke, dass dieser Bereich ** nachgeahmt werden sollte, ohne jetzt tief nachzudenken **.

GroupId und ArtifactId

Legen Sie zunächst die GroupId und die ArtifactId fest. Dies ist nicht wie Minecraft, es scheint eine Anfrage von Java zu sein, aber ich bin nicht damit vertraut, also werde ich es weglassen.

Es gibt eine allgemeine Möglichkeit, zu entscheiden, wie ein Paket benannt werden soll.

--GroupId: Der Name der Organisation. Im Allgemeinen ist das Format zum Schreiben der Domain umgekehrt --ArtifactId: Name des Projekts

Also habe ich folgendes gemacht.

Bitte ändern Sie es nach Ihren Wünschen. Benennen Sie den Ordner basierend darauf um.

Vorher ändern

D:\projects\mc_example_mod\src\main\java
  └ com
      └ example
　         └ examplemod
　             └ ExampleMod.java

Nach der veränderung

D:\projects\mc_example_mod\src\main\java
  └ jp
     └ koteko
          └ example_mod
              └ ExampleMod.java

Assets-Ordner

Erstellen Sie als Nächstes einen Ordner "resources \ example_mod", in dem Sie Dateien wie Texturen und Soundeffekte ablegen können.

D:\projects\mc_example_mod\src\main\resources
   ├ assets
   │  └ example_mod
   ├ META-INF
   │   └ mods.toml
   └ pack.mcmeta

pack.mcmeta Was sind die Dateien bereits vorhanden? Schauen wir uns jeden an.

pack.mcmeta

{
    "pack": {
        "description": "examplemod resources",
        "pack_format": 4,
        "_comment": "A pack_format of 4 requires json lang files. Note: we require v4 pack meta for all mods."
    }
}

Die Datei "pack.mcmeta" ist eine Datei, die die Details des Ressourcenpakets beschreibt. Weitere Informationen finden Sie unter Wiki. Sie können die Beschreibung "ändern" und die Zeile "_comment" löschen, da sie nicht benötigt wird.

Nach der veränderung

{
    "pack": {
        "description": "Example Mod resources",
        "pack_format": 4
    }
}

mods.toml

mods.toml

# This is an example mods.toml file. It contains the data relating to the loading mods.
# There are several mandatory fields (#mandatory), and many more that are optional (#optional).
# The overall format is standard TOML format, v0.5.0.
# Note that there are a couple of TOML lists in this file.
# Find more information on toml format here:  https://github.com/toml-lang/toml
# The name of the mod loader type to load - for regular FML @Mod mods it should be javafml
modLoader="javafml" #mandatory
# A version range to match for said mod loader - for regular FML @Mod it will be the forge version
loaderVersion="[28,)" #mandatory (28 is current forge version)
# A URL to refer people to when problems occur with this mod
issueTrackerURL="http://my.issue.tracker/" #optional
# A list of mods - how many allowed here is determined by the individual mod loader
[[mods]] #mandatory
# The modid of the mod
modId="examplemod" #mandatory
# The version number of the mod - there's a few well known ${} variables useable here or just hardcode it
version="${file.jarVersion}" #mandatory
 # A display name for the mod
displayName="Example Mod" #mandatory
# A URL to query for updates for this mod. See the JSON update specification <here>
updateJSONURL="http://myurl.me/" #optional
# A URL for the "homepage" for this mod, displayed in the mod UI
displayURL="http://example.com/" #optional
# A file name (in the root of the mod JAR) containing a logo for display
logoFile="examplemod.png " #optional
# A text field displayed in the mod UI
credits="Thanks for this example mod goes to Java" #optional
# A text field displayed in the mod UI
authors="Love, Cheese and small house plants" #optional
# The description text for the mod (multi line!) (#mandatory)
description='''
This is a long form description of the mod. You can write whatever you want here

Have some lorem ipsum.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed mollis lacinia magna. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed sagittis luctus odio eu tempus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Pellentesque volutpat ligula eget lacus auctor sagittis. In hac habitasse platea dictumst. Nunc gravida elit vitae sem vehicula efficitur. Donec mattis ipsum et arcu lobortis, eleifend sagittis sem rutrum. Cras pharetra quam eget posuere fermentum. Sed id tincidunt justo. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
'''
# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional.
[[dependencies.examplemod]] #optional
    # the modid of the dependency
    modId="forge" #mandatory
    # Does this dependency have to exist - if not, ordering below must be specified
    mandatory=true #mandatory
    # The version range of the dependency
    versionRange="[28,)" #mandatory
    # An ordering relationship for the dependency - BEFORE or AFTER required if the relationship is not mandatory
    ordering="NONE"
    # Side this dependency is applied on - BOTH, CLIENT or SERVER
    side="BOTH"
# Here's another dependency
[[dependencies.examplemod]]
    modId="minecraft"
    mandatory=true
    versionRange="[1.14.4]"
    ordering="NONE"
    side="BOTH"

Die Datei mods.toml ist eine Datei, die Mod-Informationen beschreibt. Neben Informationen wie Abhängigkeiten sind hier auch die Informationen enthalten, die bei der Installation des Mods auf dem Bildschirm angezeigt werden. Ändern Sie sie daher bei Bedarf.

Es ist lang, aber die Erklärung der einzelnen Elemente wird nur im Kommentar geschrieben. Löschen Sie sie daher (stellen Sie sie bei Bedarf als Referenz zur Verfügung). "obligatorisch" ist erforderlich und "optional" ist optional. Das Folgende ist ein Beispiel für eine angemessene Bearbeitung.

Nach der veränderung

modLoader="javafml"
loaderVersion="[28,)"
[[mods]]
modId="example_mod"
version="${file.jarVersion}"
displayName="Example Mod"
logoFile="logo.png "
description='''
Hier
Erläuterung
Eingang
'''

[[dependencies.example_mod]]
    modId="forge"
    mandatory=true
    versionRange="[28,)"
    ordering="NONE"
    side="BOTH"

[[dependencies.example_mod]]
    modId="minecraft"
    mandatory=true
    versionRange="[1.14.4]"
    ordering="NONE"
    side="BOTH"

Außerdem wird logo.png direkt unter resources als Mod-Logo-Bild platziert.

D:\projects\mc_example_mod\src\main\resources
   ├ assets
   │  └ example_mod
   ├ META-INF
   │   └ mods.toml
   ├ logo.png
   └ pack.mcmeta

Infolgedessen hat sich die Bildschirmanzeige wie folgt geändert.

Hauptdatei

ExampleMod.java

package jp.koteko.example_mod;

import net.minecraft.block.Block;
import net.minecraft.block.Blocks;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.event.RegistryEvent;
import net.minecraftforge.eventbus.api.SubscribeEvent;
import net.minecraftforge.fml.InterModComms;
import net.minecraftforge.fml.common.Mod;
import net.minecraftforge.fml.event.lifecycle.FMLClientSetupEvent;
import net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent;
import net.minecraftforge.fml.event.lifecycle.InterModEnqueueEvent;
import net.minecraftforge.fml.event.lifecycle.InterModProcessEvent;
import net.minecraftforge.fml.event.server.FMLServerStartingEvent;
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.util.stream.Collectors;

// The value here should match an entry in the META-INF/mods.toml file
@Mod("example_mod")
public class ExampleMod
{
    // Directly reference a log4j logger.
    private static final Logger LOGGER = LogManager.getLogger();

    public ExampleMod() {
        // Register the setup method for modloading
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::setup);
        // Register the enqueueIMC method for modloading
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::enqueueIMC);
        // Register the processIMC method for modloading
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::processIMC);
        // Register the doClientStuff method for modloading
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::doClientStuff);

        // Register ourselves for server and other game events we are interested in
        MinecraftForge.EVENT_BUS.register(this);
    }

    private void setup(final FMLCommonSetupEvent event)
    {
        // some preinit code
        LOGGER.info("HELLO FROM PREINIT");
        LOGGER.info("DIRT BLOCK >> {}", Blocks.DIRT.getRegistryName());
    }

    private void doClientStuff(final FMLClientSetupEvent event) {
        // do something that can only be done on the client
        LOGGER.info("Got game settings {}", event.getMinecraftSupplier().get().gameSettings);
    }

    private void enqueueIMC(final InterModEnqueueEvent event)
    {
        // some example code to dispatch IMC to another mod
        InterModComms.sendTo("examplemod", "helloworld", () -> { LOGGER.info("Hello world from the MDK"); return "Hello world";});
    }

    private void processIMC(final InterModProcessEvent event)
    {
        // some example code to receive and process InterModComms from other mods
        LOGGER.info("Got IMC {}", event.getIMCStream().
                map(m->m.getMessageSupplier().get()).
                collect(Collectors.toList()));
    }
    // You can use SubscribeEvent and let the Event Bus discover methods to call
    @SubscribeEvent
    public void onServerStarting(FMLServerStartingEvent event) {
        // do something when the server starts
        LOGGER.info("HELLO from server starting");
    }

    // You can use EventBusSubscriber to automatically subscribe events on the contained class (this is subscribing to the MOD
    // Event bus for receiving Registry Events)
    @Mod.EventBusSubscriber(bus=Mod.EventBusSubscriber.Bus.MOD)
    public static class RegistryEvents {
        @SubscribeEvent
        public static void onBlocksRegistry(final RegistryEvent.Register<Block> blockRegistryEvent) {
            // register a new block here
            LOGGER.info("HELLO from Register Block");
        }
    }
}

Dies ist die Hauptmod-Datei. Zunächst können Sie es so verwenden, wie es ist, und wenn Sie es bis zu einem gewissen Grad verstehen, können Sie es nach Bedarf umschreiben. Hierbei ist zu beachten, ob der Dateiname (ExampleMod.java) mit dem Klassennamen ( public class ExampleMod) und dem Konstruktor (public ExampleMod ()) sowie der modId-Spezifikation (`` übereinstimmt Ist @Mod ("exampleplemod") ) dasselbe wie in mods.toml` angegeben? Wenn nicht, lassen Sie es uns beheben.

Referenz

Minecraft 1.14.4 Forge Mod Creation Teil 2 [Grundlegende Platzierung von Dateien]

Nächster Artikel

1. Elemente hinzufügen