Matthiesen Core

Matthiesen Core

Matthiesen Core is a library mod for NeoForge and Fabric that enables developers to create mods with a shared common codebase. It provides a set of core functionalities and utilities that can be used across multiple mods, allowing for easier development and maintenance. Instead of maintaining separate implementations for each platform, you can write your mod logic once in common code and let Matthiesen core handle the platform-specific details.

Matthiesen Core does not have to be installed on the client if the mod depending on it is server-side only. However, if the mod(s) that depend on Matthiesen Core have client-side components, then Matthiesen Core must be installed on the client as well.

> Note: For regular users, This library does nothing on its own aside from setting up the core functionality for other mods to utilize. > If you are not a mod developer, simply drop the mod in your mods/ folder alongside the other mods that depend on it, and you are good to go.

Matthiesen Core is the successor to Matthiesen Lib and Matthiesen Lib Api, which were two separate libraries that have now been combined into a single unified library mod, that provides a more streamlined and efficient experience for mod developers.

Features

Matthiesen Core provides a unified API for:

• Content Registration: Register blocks, items, entities, and other game content in a platform-agnostic way.
• Event Handling: Listen to and handle game events across different platforms.
• Networking: Send and receive network packets between the client and server.
• Configuration Management: Manage mod configurations and settings in a consistent manner.
• Utility Functions: Access a variety of utility functions for common tasks, such as logging, resource management, and more.
• Client-Side Features: Includes client-specific features like HUD management, keybinding handling, and screen management.
• Permission Management: Provides a permission system for managing access to certain features or commands.

Required Dependencies

• Fabric API (Fabric only)
• Forge Config API Port (Fabric only)

Optional Dependencies

• Adventure Platform Mod
• Ember's Text API
• Impactor
• LuckPerms
• Minecraft SQLite JDBC
• Minecraft MySQL JDBC
• Fabric Permissions API (Fabric only)

Version Compatibility

| Minecraft Version | Mod Version | |-------------------|-------------| | 1.21.1 | 1.x.x |

Developer Quick Start

Matthiesen Core development versions and sources are available from Matthiesen Dev Maven.

Gradle

Step 1: Add the Maven repository to your build.gradle.kts file

repositories {
    maven("https://maven.matthiesen.dev/releases") {
        name = "devMatthiesenMaven-releases"
    }
    // For Snapshot versions, also include the snapshots repository
    maven("https://maven.matthiesen.dev/snapshots") {
        name = "devMatthiesenMaven-snapshots"
    }
}

Step 2: Add the version property to your gradle.properties file

matthiesen_core_version=1.x.x

> Note: Replace 1.x.x with the latest version of Matthiesen Core. You can find the latest version on Matthiesen Dev Maven or see the table below for the latest version.

| Release Type | Version Badge | |--------------|------------------------------------------------------------------------------------------------------------------------------------------------| | Latest Release | |

Step 3: Add the dependency to your build.gradle.kts file

// In common/build.gradle.kts
dependencies {
    modImplementation("dev.matthiesen:matthiesen-core-common:${property("matthiesen_core_version")}") {
        isTransitive = false
    }
}

// In fabric/build.gradle.kts
dependencies {
    modImplementation("dev.matthiesen:matthiesen-core-fabric:${property("matthiesen_core_version")}") {
        isTransitive = false
    }
}

// In neoforge/build.gradle.kts
dependencies {
    modImplementation("dev.matthiesen:matthiesen-core-neoforge:${property("matthiesen_core_version")}") {
        isTransitive = false
    }
}

Step 4: Loader-specific Dependency Setup

For Fabric and NeoForge, you will need to add the appropriate loader-specific dependency to your mod metadata file (e.g., fabric.mod.json for Fabric or neoforge.mods.toml for NeoForge). This ensures that the correct version of Matthiesen Core is loaded alongside your mod.

Fabric Example (fabric.mod.json):

{
  "depends": {
    "matthiesen_core": ">=1.x.x"
  }
}

NeoForge Example (neoforge.mods.toml):

[[dependencies.yourmodid]]
modId = "matthiesen_core"
type = "required"
versionRange = "[1.x.x,)"
ordering = "AFTER"
side = "BOTH"

Step 5: Sync your project and set up your common mod codebase to use Matthiesen Core's APIs for content registration, event handling, networking, and other features.