This repository contains the source-code of "TCDCommons API", TheCSDev's personal Minecraft modding library.

(The thumbnail is a screenshot of source code for one of the main GUI API classes; TScreen.java, shown in IntelliJ IDEA editor.)

Important

This repository contains versions starting from v5.0. If you’re looking for legacy releases (v4.0 and earlier), please see the archived repository: https://github.com/TheCSDev/tcdcommons-v4

Introduction

TCDCommons is a Minecraft modding API library that features its own GUI system and various events and hooks for the game, as well as utilities that may be useful to mod developers. This API's main purpose is to help optimize and speed up the development of mods, as well as to avoiding re-writing the same code for every mod that needs to do similar things. Please note that because this mod is a library, it may not offer useful front-end features to the user.

Key features

• 🖥️ Robust GUI framework
• ⚙ JSON-based config system
• 🎣 Additional 'hooks' useful for modding the game

Dependencies

This mod depends on some other mods that first need to be installed before this mod can be installed. Those dependencies are as follows:

• 🏗 Architectury API - Allows this mod to run on Fabric and NeoForge

Building

Follow these steps to build the project from source.

Prerequisites

• Java 21: Ensure you have the Java Development Kit (JDK) 21 installed.
• Git: Required to clone this repository.

Instructions

1. Clone the repository

git clone https://github.com/TheCSDev/tcdcommons.git
cd tcdcommons

2. Build the mod

./gradlew clean build

Note: Use gradlew.bat clean build if you are on Windows.

The compiled .jar file will be located in build/libs/.