DillonLib

[!(https://github.com/Dillon8775/ImageGIFs/blob/universal/9i8dnw.gif?raw=true)](https://youtu.be/CurMwVkAqWo)

# Base Library/API for Dillon's mods.

Cross-platform API providing resuable utilities, such as platform abstraction, mixin management, configuration systems, factories, and other common modding utilities.

## Developer Notes

Provides all information required to create a mod on multiple modding platforms (ex. Fabric, Forge and NeoForge).

Provides other resources, including: - Factories, which auto-registers certain behaviors for certain types of objects - Memory-stored player data, based on UUID - Easy-to-use mixin predicates - Scheduled tasks that run within the Minecraft server tick - Simple permissions getter - Tick calculators - A clean options system - Common texts - Common client-side operations and modern-styled widget lists

DillonLib does not require any other outside resources or mods, other than (https://modrinth.com/mod/fabric-api) for fabric users.

You can view the *(https://github.com/Dillon8775/Dillon-Lib)** for all features and utilities, as well as read documentation below.

### To use this library with your mod, add this to your `build.gradle` file:

``` repositories { exclusiveContent { forRepository { maven { name = "Modrinth" url = "https://api.modrinth.com/maven" } } filter { includeGroup "maven.modrinth" } } }

dependencies { implementation "maven.modrinth:dillon-lib:DL_version" // Note: for DL_version, make sure you use the correct MC and platform (fabric/neoforge/forge) version. // You can get it by opening the specified version and copying the end of the modrinth link. // Example: https://modrinth.com/mod/dillon-lib/version/5voax3wu <- use "5voax3wu" as the DL_version! } ```

### For multi-loader mods (fabric x (neo)forge), in your common directory, you must add this: ``` compileOnly "maven.modrinth:dillon-lib:${project.DL_version /<- can either be Fabric or NeoForge, but I recommend fabric/}" ``` Then, in your other modules (ex. fabric or neoforge), add the normal implementation block provided above for your specified module.

• --
• # API Documentation

# Platform Abstraction This API provides a versatile way to store a mod's basic information with the help of a built-in Java feature called Service Loaders.

You can think of a service loader as your mod's base entrypoint, or table of contents. The service loader contains information like your mod version, mod ID, platform name (fabric, neoforge, forge, or other), platform release (stable, beta or alpha), and other useful utilities.

DillonLib provides three different service loaders for you to create. One for your base entrypoint ```(called ModPlatform.class)```, one specifically designed for mixins ```(called MixinModPlatform.class)```, and one for client-side operations ```(called ClientModPlatform)```.

You technically do not need to create all platforms. Each platform contains necessary information required to register certain things.

(https://github.com/Dillon8775/Dillon-Lib/blob/mc26. 2/common/src/main/java/net/dillon/dillonlib/platform/ModPlatform.java).

(https://github.com/Dillon8775/Dillon-Lib/blob/mc26. 2/common/src/main/java/net/dillon/dillonlib/platform/client/ClientModPlatform.java).

(https://github.com/Dillon8775/Dillon-Lib/blob/mc26. 2/common/src/main/java/net/dillon/dillonlib/platform/mixinsafe/MixinModPlatform.java).

These platforms are designed to work on projects that are coded on multiple mod loaders, so each mod loader should have its own platform classes.

To properly create your service loader, simply create instances of these platform classes, and fill in your information.

Then, in your mods ```resources``` folder, create a directory called `META-INF/services`, and then create the following files (depending on which platforms you are using), with these exact names:

``` net.dillon.dillonlib.platform.client. ClientModPlatform net.dillon.dillonlib.platform.mixinsafe. MixinModPlatform net.dillon.dillonlib.platform. ModPlatform ```

In each of these files, you should enter in the path to your platform. For example, inside of ```net.dillon.dillonlib.platform. ModPlatform``` should be: ``` net.dillon.quesoexample.platform. QuesoExamplePlatformImpl ```

If you are extending a platform with a custom platform, ex. MyModPlatform extends ModPlatform, if your custom platform only has methods that are inherited from an original platform class, you must specify your extended platform in the file. However, if you have a custom platform with custom methods that are not inherited from the original platform class, you must specify your extended platform in the file and additionally* create a new fi