[Java] Créons un Minecraft Mod 1.14.4 [0. Fichier de base]

(Cet article fait partie d'une série d'articles de commentaires)

Premier article: Introduction Article précédent: Introduction Article suivant: 1. Ajouter des éléments

Fichier de base

L'environnement de développement est prêt et nous sommes enfin sur la ligne de départ. À partir de maintenant, préparons-nous à poursuivre le Modding. Je pense que ce domaine ** devrait être imité sans réfléchir profondément maintenant **.

GroupId et ArtifactId

Tout d'abord, définissez GroupId et ArtifactId. Ce n'est pas comme Minecraft, cela semble être une demande de Java, mais je ne suis pas familier avec cela, donc je vais l'omettre.

Il existe une manière générale de décider comment nommer un paquet.

--GroupId: Le nom de l'organisation. Généralement, le format pour écrire le domaine à l'envers --ArtifactId: Nom du projet

J'ai donc fait ce qui suit.

Veuillez le changer selon vos besoins. Renommez le dossier en fonction de cela.

Changer avant

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

Après le changement

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

dossier des actifs

Ensuite, créez un dossier ʻassets \ example_mod` où vous pouvez placer des fichiers tels que des textures et des effets sonores.

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

pack.mcmeta Alors, quels sont les fichiers déjà en place? Regardons chacun d'eux.

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

Le fichier pack.mcmeta est un fichier qui décrit les détails du pack de ressources. Pour plus de détails, reportez-vous au Wiki. N'hésitez pas à modifier la description et à supprimer la ligne _comment car elle n'est pas nécessaire.

Après le changement

{
    "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"

Le fichier mods.toml est un fichier qui décrit les informations Mod. En plus des informations telles que les dépendances, les informations affichées à l'écran lorsque le mod est installé sont également incluses ici, donc modifiez-les si nécessaire.

C'est long, mais l'explication de chaque élément n'est écrite que dans le commentaire, alors supprimons-le (rendez-le disponible pour référence si nécessaire). «obligatoire» est obligatoire et «optionnel» est facultatif. Voici un exemple de modification appropriée.

Après le changement

modLoader="javafml"
loaderVersion="[28,)"
[[mods]]
modId="example_mod"
version="${file.jarVersion}"
displayName="Example Mod"
logoFile="logo.png "
description='''
ici
Explication
contribution
'''

[[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"

De plus, logo.png est placé directement sous resources comme image du logo Mod.

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

En conséquence, l'affichage de l'écran a changé comme suit.

Dossier principal

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");
        }
    }
}

Ceci est le fichier mod principal. Tout d'abord, vous pouvez l'utiliser tel quel, et si vous le comprenez dans une certaine mesure, vous pouvez le réécrire si nécessaire. Le point à noter ici est que le nom du fichier (ʻExampleMod.java) correspond au nom de la classe (public class ExampleMod) et au constructeur ( public ExampleMod () ), et à la spécification modId ( @Mod ("examplemod") ) est-il le même que celui spécifié dans mods.toml`? Sinon, réparons-le.

référence

Minecraft 1.14.4 Forge Mod Creation Part 2 [Basic File Placement]

Article suivant

1. Ajouter des éléments