Hytale Plugin Template / Modelo de Plugin Hytale

🇬🇧 English | 🇧🇷 Português

---

🇬🇧 English

Overview

This is a robust template for creating Hytale server plugins. It includes a setup script that allows you to easily generate the project structure for new mods. The template supports creating multiple mods from the same base by copying the template files instead of moving them.

Prerequisites

• Java 25 (Required for Hytale server version > 2026.01.24)
• Git Bash (Recommended for Windows users if running .sh scripts) or PowerShell (for .bat)

How to Use

1. Run the Setup Script:

   • Windows: Double-click setup.bat or run it from a terminal.
   • Linux/Mac:

     chmod +x setup.sh
     ./setup.sh

2. Follow the Prompts: The script will ask for:

   • Project Name: The name of your plugin (e.g., MyAwesomeMod).
   • Author Name: Your name or handle.
   • Website URL: Your website or project repository.
   • Package Name: The Java package for your code (e.g., com.myname.mymod).

3. Code Generation: The script will:

   • Update build.gradle and settings.gradle with your project details.
   • Copy the template files from the files/ directory to src/main/java/ and src/main/resources.
   • Automatically refactor the package declarations in the Java files to match your input.

4. Build: Run the build command to compile your plugin:

   ./gradlew build

   The compiled JAR file will be located in the dist/ directory.

Project Structure

• files/: Contains the template source code (Java files and manifest.json). Do not modify these unless you want to change the template itself.
• src/: This directory is generated by the setup script and contains your actual working code.
• setup.bat / setup.sh: Configuration scripts to initialize the project.

---

🇧🇷 Português

Visão Geral

Este é um modelo robusto para criar plugins de servidor Hytale. Ele inclui um script de configuração que permite gerar facilmente a estrutura do projeto para novos mods. O modelo suporta a criação de vários mods a partir da mesma base, copiando os arquivos de modelo em vez de movê-los.

Pré-requisitos

• Java 25 (Necessário para a versão do servidor Hytale > 2026.01.24)
• Git Bash (Recomendado para usuários Windows se for rodar scripts .sh) ou PowerShell (para .bat)

Como Usar

1. Execute o Script de Configuração:

   • Windows: Clique duas vezes em setup.bat ou execute-o em um terminal.
   • Linux/Mac:

     chmod +x setup.sh
     ./setup.sh

2. Siga as Instruções: O script pedirá:

   • Project Name (Nome do Projeto): O nome do seu plugin (ex: MeuModIncrivel).
   • Author Name (Nome do Autor): Seu nome ou nick.
   • Website URL (URL do Site): Seu site ou repositório do projeto.
   • Package Name (Nome do Pacote): O pacote Java para seu código (ex: com.meunome.meumod).

3. Geração de Código: O script irá:

   • Atualizar build.gradle e settings.gradle com os detalhes do seu projeto.
   • Copiar os arquivos de modelo do diretório files/ para src/main/java/ e src/main/resources.
   • Refatorar automaticamente as declarações de pacote nos arquivos Java para corresponder à sua entrada.

4. Compilar (Build): Execute o comando de build para compilar seu plugin:

   ./gradlew build

   O arquivo JAR compilado estará localizado no diretório dist/.

Estrutura do Projeto

• files/: Contém o código-fonte do modelo (arquivos Java e manifest.json). Não modifique estes arquivos a menos que queira alterar o próprio modelo.
• src/: Este diretório é gerado pelo script de configuração e contém seu código de trabalho real.
• setup.bat / setup.sh: Scripts de configuração para inicializar o projeto.