Skip to content

INSTALL.md

Latest commit

 

History

History
69 lines (52 loc) · 2.16 KB

INSTALL.md

File metadata and controls

69 lines (52 loc) · 2.16 KB

Building CreatureChat™

This guide will walk you through the steps required to clone and build the CreatureChat™ Fabric Mod from our Git repository. NOTE: Please ensure you have Git installed on your computer before you begin. You will also need Java and an appropriate Gradle setup to build the mod.

Prerequisites

  • Git: If you don't have Git installed, download and install it from git-scm.com.
  • Java JDK: Fabric requires Java Development Kit (JDK) to compile and run. Download and install it from AdoptOpenJDK or your preferred JDK provider. JDK version 8 or 11 is recommended.
  • IDE: Any IDE that supports Java and Gradle, such as IntelliJ IDEA, Eclipse, or VS Code.

Clone the Repository

Open a terminal or command prompt and run the following command to clone the repository:

git clone https://github.com/CreatureChat/creature-chat.git

Navigate into the cloned directory:

cd creature-chat

Build the Mod

Use the Gradle wrapper included in the repository to build the project. Run the following command in the terminal within the project directory:

./gradlew build

For Windows users, use:

gradlew.bat build

This command compiles the project and outputs the build artifacts, including the mod .jar file, into the build/libs directory.

Testing the Mod

To test the mod, you can run it in a development environment provided by Fabric:

./gradlew runClient

For Windows users, use:

gradlew.bat runClient

This command launches a Minecraft client with the mod loaded, allowing you to test the mod's functionality directly.

Updating Dependencies

When Fabric or Minecraft is updated, the build dependencies also need to be updated. Below are the general steps for this upgrade process.

  1. Visit https://fabricmc.net/develop for updated version #s
  2. Copy/paste the recommended versions into gradle.properties
  3. Optional: Update the Loom version in build.gradle
  4. Re-build: ./gradlew build and watch for any errors
  5. Re-run: ./gradlew runClient
  6. Optional: Re-start IDE to clear cached gradle