MinecraftMods/BCLib
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated README.md

Browse source
This commit is contained in:
Frank 2022-06-07 23:30:28 +02:00
parent 223d35febe
commit af3fca0c41
1 changed files with 76 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1,9 +1,31 @@
[![](https://jitpack.io/v/quiqueck/BCLib.svg)](https://jitpack.io/#quiqueck/BCLib)
# BCLib
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:
### Rendering
* Emissive textures (with _e suffix)
* Can be applied to Solid and Transparent blocks;
* 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.
### API:
* Simple Mod Integration API:
* Get mod inner methods, classes and objects on runtime.
* 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.
### Libs:
* Spline library (simple):
* Helper to create simple splines as set of points;
* 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.
### Helpers And Utils:
* Custom surface builders.
* Translation helper:
* 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;
### Complex Materials
* Utility classes used for mass content generation (wooden blocks, stone blocks, etc.);
* 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);
* 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:
* Most basic blocks from MC;
* Automatic item & block model generation;
### Configs:
* Custom config system based on Json;
* Hierarchical configs;
* Different entry types;
* Only-changes saves.
### Interfaces:
* BlockModelProvider:
* Allows block to return custom model and blockstate.
* ItemModelProvider:
@ -94,13 +124,8 @@ BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.19
* CustomItemProvider:
* 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:
* Clone repo
* Run command line in folder: gradlew build
* Mod .jar will be in ./build/libs