[Java] Créons un Minecraft Mod 1.16.1 [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:

Fichier de base

Nous allons définir les fichiers de base. Il y a des fichiers copiés et collés dans Dernière fois, je vais donc les changer moi-même.

nom du paquet

Convention de dénomination des packages #% E3% 83% 91% E3% 83% 83% E3% 82% B1% E3% 83% BC% E3% 82% B8% E5% 91% BD% E5% 90% 8D% E8% A6% 8F Si vous lisez% E7% B4% 84), vous devrez éviter les conflits en utilisant votre domaine comme espace de noms. Cependant, je n'ai pas de domaine, alors j'ai fait ce qui suit.

Changer avant

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

Après le changement

D:\projects\mc_liveinwater\src\main\java
  └ jp
     └ koteko
          └ liveinwater
              └ LiveInWater.java

dossier assets, dossier de données

Créez un dossier ʻassets \ liveinwaterpour placer des fichiers tels que des textures et des effets sonores, et un dossierdata \ liveinwater` pour placer des fichiers tels que des recettes et des tables de dépôt.

D:\projects\mc_liveinwater\src\main\resources
   ├ assets
   │  └ liveinwater
   ├ data
   │  └ liveinwater
   ├ META-INF
   │   └ mods.toml
   └ pack.mcmeta

pack.mcmeta 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. Depuis la 1.15, pack_format vaut 5. La ligne de commentaire n'est pas nécessaire, supprimez-la.

Après le changement

{
    "pack": {
        "description": "live in water Mod resources",
        "pack_format": 5
    }
}

mods.toml 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 les commentaires, alors lisez-le attentivement et réglez-le correctement. «obligatoire» est obligatoire et «optionnel» est facultatif.

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="[32,)" #mandatory This is typically bumped every Minecraft version by Forge. See our download page for lists of versions.
# The license for you mod. This is mandatory metadata and allows for easier comprehension of your redistributive properties.
# Review your options at https://choosealicense.com/. All rights reserved is the default copyright stance, and is thus the default here.
license="MIT License"
# 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="liveinwater" #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="live in water 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='''
live in water
 – deep, silent, sea.
'''
# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional.
[[dependencies.liveinwater]] #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="[32,)" #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.liveinwater]]
    modId="minecraft"
    mandatory=true
    versionRange="[1.16.1]"
    ordering="NONE"
    side="BOTH"

Concernant la licence, si vous pensez à la distribution dans le futur, vous devriez lire attentivement la page de référence etc. dans le commentaire et la définir correctement. (Je ne suis pas familier avec cela, donc je l'ai défini comme licence MIT.) D'autres éléments non essentiels ont été commentés le cas échéant.

Dossier principal

LiveInWater.java (à l'origine ʻExampleMod.java`) est la classe principale de Mod. Effacez les choses qui ne sont évidemment pas utilisées pour le rendre plus propre.

LiveInWater.java

package jp.koteko.liveinwater;

import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.eventbus.api.SubscribeEvent;
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;

@Mod("liveinwater")
public class LiveInWater
{
    private static final Logger LOGGER = LogManager.getLogger();

    public LiveInWater() {
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::setup);
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::enqueueIMC);
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::processIMC);
        FMLJavaModLoadingContext.get().getModEventBus().addListener(this::doClientStuff);

        MinecraftForge.EVENT_BUS.register(this);
    }

    private void setup(final FMLCommonSetupEvent event)
    {
        LOGGER.info("SETUP START");

        LOGGER.info("SETUP END");
    }

    private void doClientStuff(final FMLClientSetupEvent event) {
        // do something that can only be done on the client
    }

    private void enqueueIMC(final InterModEnqueueEvent event)
    {
        // some example code to dispatch IMC to another mod
    }

    private void processIMC(final InterModProcessEvent event)
    {
        // some example code to receive and process InterModComms from other mods
    }

    @SubscribeEvent
    public void onServerStarting(FMLServerStartingEvent event) {
        LOGGER.info("server starting");
    }
}

Assurez-vous que le nom du fichier (LiveInWater.java) correspond au nom de la classe ( public class LiveInWater) et au constructeur (public LiveInWater ()). Assurez-vous également que la spécification modId (@Mod (" liveinwater ")) est la même que celle de mods.toml édité ci-dessus. L'image de ce que fait cette classe est de mettre quatre cycles de vie sur un rail et d'insérer ce rail sur la Forge. Je ne connais pas encore ces traitements, je vais donc en laisser quatre pour le moment. De plus, je pense qu'il y avait un code pour enregistrer le bloc à la fin, mais je l'ai supprimé sur ce fichier car il serait plus propre de préparer une classe séparée.

Confirmation de démarrage

Enfin, assurez-vous que le jeu démarre au cas où. Une fois démarré, ouvrez les mods et vérifiez que les informations ont été mises à jour. VERSION est NONE, mais comme il est donné lors de la construction du fichier jar Mod, il est NONE ici.

référence

Structuring Your Mod - Forge Documentation [Java] Créons un Minecraft Mod 1.14.4 [0. Fichier de base] Minecraft 1.14.4 Forge Mod Creation Part 2 [Basic File Placement]

Article suivant