Updated README.md

This commit is contained in:
Frank 2022-06-07 23:30:28 +02:00
parent 223d35febe
commit af3fca0c41

View file

@ -1,9 +1,31 @@
[![](https://jitpack.io/v/quiqueck/BCLib.svg)](https://jitpack.io/#quiqueck/BCLib) [![](https://jitpack.io/v/quiqueck/BCLib.svg)](https://jitpack.io/#quiqueck/BCLib)
# BCLib # BCLib
BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.19 BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.19
## Importing:
You can easily include BCLib into your own mod by adding the following to your `build.gradle`:
```json
repositories {
...
maven { url 'https://jitpack.io' }
}
```
```json
dependencies {
...
modImplementation "com.github.quiqueck:BCLib:${project.bclib_version}"
}
```
## Features: ## Features:
### Rendering ### Rendering
* Emissive textures (with _e suffix) * Emissive textures (with _e suffix)
* Can be applied to Solid and Transparent blocks; * Can be applied to Solid and Transparent blocks;
* Can be changed/added with resourcepacks; * Can be changed/added with resourcepacks;
@ -13,6 +35,7 @@ BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.19
* Block render interfaces. * Block render interfaces.
### API: ### API:
* Simple Mod Integration API: * Simple Mod Integration API:
* Get mod inner methods, classes and objects on runtime. * Get mod inner methods, classes and objects on runtime.
* Structure Features API: * Structure Features API:
@ -36,6 +59,7 @@ BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.19
* Adding blocks and items into tags at runtime. * Adding blocks and items into tags at runtime.
### Libs: ### Libs:
* Spline library (simple): * Spline library (simple):
* Helper to create simple splines as set of points; * Helper to create simple splines as set of points;
* Some basic operation with splines; * Some basic operation with splines;
@ -54,6 +78,7 @@ BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.19
* Feature generation using SDF. * Feature generation using SDF.
### Helpers And Utils: ### Helpers And Utils:
* Custom surface builders. * Custom surface builders.
* Translation helper: * Translation helper:
* Generates translation template. * Generates translation template.
@ -65,22 +90,27 @@ BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.19
* Some useful functions to operate with blocks; * Some useful functions to operate with blocks;
### Complex Materials ### Complex Materials
* Utility classes used for mass content generation (wooden blocks, stone blocks, etc.); * Utility classes used for mass content generation (wooden blocks, stone blocks, etc.);
* Contains a set of defined blocks, items, recipes and tags; * Contains a set of defined blocks, items, recipes and tags;
* Can be modified before mods startup (will add new block type for all instances in all mods); * Can be modified before mods startup (will add new block type for all instances in all mods);
* All inner blocks and items are Patterned (will have auto-generated models with ability to override them with resource packs or mod resources). * All inner blocks and items are Patterned (will have auto-generated models with ability to override them with resource
packs or mod resources).
### Pre-Defined Blocks and Items: ### Pre-Defined Blocks and Items:
* Most basic blocks from MC; * Most basic blocks from MC;
* Automatic item & block model generation; * Automatic item & block model generation;
### Configs: ### Configs:
* Custom config system based on Json; * Custom config system based on Json;
* Hierarchical configs; * Hierarchical configs;
* Different entry types; * Different entry types;
* Only-changes saves. * Only-changes saves.
### Interfaces: ### Interfaces:
* BlockModelProvider: * BlockModelProvider:
* Allows block to return custom model and blockstate. * Allows block to return custom model and blockstate.
* ItemModelProvider: * ItemModelProvider:
@ -94,13 +124,8 @@ BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.19
* CustomItemProvider: * CustomItemProvider:
* Allows block to change its registered item (example - signs, water lilies). * Allows block to change its registered item (example - signs, water lilies).
## Importing:
* Clone repo
* Edit gradle.properties if necessary
* Run command line in folder: gradlew genSources eclipse (or Another-IDE-Name)
* Import project to IDE
## Building: ## Building:
* Clone repo * Clone repo
* Run command line in folder: gradlew build * Run command line in folder: gradlew build
* Mod .jar will be in ./build/libs * Mod .jar will be in ./build/libs