Description update

This commit is contained in:
paulevsGitch 2021-07-21 02:09:57 +03:00
parent cdc9d85b53
commit 2bfc985403

View file

@ -1,33 +1,92 @@
[![](https://jitpack.io/v/paulevsGitch/BCLib.svg)](https://jitpack.io/#paulevsGitch/BCLib) [![](https://jitpack.io/v/paulevsGitch/BCLib.svg)](https://jitpack.io/#paulevsGitch/BCLib)
# BCLib # BCLib
BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.16.5 BCLib is a library mod for BetterX team mods, developed for Fabric, MC 1.17.1
## Features: ## Features:
### Rendering
* Emissive textures (with _e suffix)
* Can be applied to Solid and Transparent blocks;
* Can be changed/added with resourcepacks;
* Incompatible with Sodium and Canvas (just will be not rendered);
* Incompatible with Iris shaders (Iris without shaders works fine).
* Procedural block and item models (from paterns or from code);
* Block render interfaces.
### API: ### API:
* Simple Mod Integration API; * Simple Mod Integration API:
* Structure Features API; * Get mod inner methods, classes and objects on runtime.
* World Data API; * Structure Features API:
* Bonemeal API; * Sructure Features with automatical registration, Helpers and math stuff.
* Features API; * World Data API:
* Biome API; * World fixers for comfortable migration between mod versions when content was removed;
* Tag API. * Support for Block name changes and Tile Entities (WIP).
* Bonemeal API:
* Add custom spreadable blocks;
* Add custom plants grow with weight, biomes and other checks;
* Custom underwater plants.
* Features API:
* Features with automatical registration, Helpers and math.
* Biome API:
* Biome wrapper around MC biomes;
* Custom biome data storage;
* Custom fog density.
* Tag API:
* Pre-builded set of tags;
* Dynamical tag registration with code;
* Adding blocks and items into tags at runtime.
### Libs: ### Libs:
* Spline library (simple); * Spline library (simple):
* Recipe manager; * Helper to create simple splines as set of points;
* Noise library; * Some basic operation with splines;
* Math library; * Converting splines to SDF.
* SDF library. * Recipe manager:
* Register recipes from code with configs and ingredients check.
* Noise library:
* Voronoi noise and Open Simplex Noise.
* Math library:
* Many basic math functions that are missing in MC.
* SDF library:
* Implementation of Signed Distance Functions;
* Different SDF Operations and Primitives;
* Different materials for SDF Primitives;
* Block post-processing;
* Feature generation using SDF.
### Helpers And Utils: ### Helpers And Utils:
* Custom surface builders; * Custom surface builders.
* Translation helper; * Translation helper:
* Weighted list; * Generates translation template.
* Block helper. * Weighted list:
* A list of objects by weight;
* Weighted Tree:
* Fast approach for big weight structures;
* Block helper:
* Some useful functions to operate with blocks;
### Rendering: ### Pre-Defined Blocks and Items:
* Procedural block models (from paterns or from code); * Most basic blocks from MC;
* Block render layer interface. * 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:
* Allows block to return custom item model.
* CustomColorProvider:
* Make available to add block and item color provider.
* RenderLayerProvider:
* Determine block render layer (Transparent and Translucent).
* PostInitable:
* Allows block to init something after all mods are loaded.
* CustomItemProvider:
* Allows block to change its registered item (example - signs, water lilies).
## Importing: ## Importing:
* Clone repo * Clone repo