A library for my smaller mods https://pages.frohnmeyer-wds.de/JfMods/LibJF/
Go to file
Johannes Frohnmeyer e93f3c5b77
Update target floader to 0.13
2022-02-06 16:40:17 +01:00
docs Document libjf-translate-v0 2022-01-28 15:49:45 +01:00
libjf-base Remove gradlew, add libjf-translate-v0 2022-01-27 15:49:08 +01:00
libjf-config-v0 Add command to reload config 2022-01-29 12:06:02 +01:00
libjf-data-manipulation-v0 Add verifiers and presets to JfConfig 2022-01-08 20:02:15 +01:00
libjf-data-v0 Rewrite LibWeb as a LibJF module 2021-11-10 16:47:15 +01:00
libjf-devutil-v0 Add verifiers and presets to JfConfig 2022-01-08 20:02:15 +01:00
libjf-translate-v0 Document libjf-translate-v0 2022-01-28 15:49:45 +01:00
libjf-unsafe-v0 Add basic "documentation" 2022-01-05 11:54:03 +01:00
libjf-web-v0 Update target floader to 0.13 2022-02-06 16:40:17 +01:00
src/main/resources Update to 1.18-pre2 2021-11-17 12:38:17 +01:00
.gitignore refactor some classes. this will break stuff so I will release it after 1.17 2021-09-27 18:25:19 +02:00
.gitlab-ci.yml Add basic "documentation" 2022-01-05 11:54:03 +01:00
LICENSE Add files 2021-04-11 16:00:37 +02:00
build.gradle Update for new build script 2021-11-29 20:36:43 +01:00
gradle.properties Update target floader to 0.13 2022-02-06 16:40:17 +01:00
mkdocs.yml Document libjf-translate-v0 2022-01-28 15:49:45 +01:00
settings.gradle Remove gradlew, add libjf-translate-v0 2022-01-27 15:49:08 +01:00

docs/README.md

About

LibJF is split into several modules, each of which provides separate functionality. This modularization is inspired by Fabric API. LibJF is only maintained for the latest version of minecraft and tries to provide a stable ABI during its lifespan but is open for breaking changes between versions.

Be aware that modules may depend on another and maven builds do not include dependencies. Modules may also require fabric-api to be present to work properly

Using LibJF

The recommended way to use LibJF is using the JfMods scripts, which include the LibJF maven repository and simplify building fabric mods. My own mods (including LibJF) use these.

Otherwise you can add the repository as follows:

repositories {
    maven { url 'https://gitlab.com/api/v4/projects/25805200/packages/maven' }
}

and include LibJF modules like this:

dependencies {
    include modImplementation("io.gitlab.jfronny.libjf:libjf-config-v0:${project.jfapi_version}")
    include("io.gitlab.jfronny.libjf:libjf-unsafe-v0:${project.jfapi_version}")
    include("io.gitlab.jfronny.libjf:libjf-base:${project.jfapi_version}")
    modRuntimeOnly("io.gitlab.jfronny.libjf:libjf-devutil-v0:${project.jfapi_version}")
}

For more information on specific modules, you can look at their own pages

Developing LibJF

To add a LibJF module, create a new directory for it and copy over a build.gradle file from elsewhere, Reference it in settings.gradle and develop it like any fabric mod. You should also create a testmod for it (look at the other modules for examples) JiJing and maven uploads are automatically managed by the JfMods scripts