diff options
| author |   alemi <me@alemi.dev> | 2023-03-12 03:42:32 +0100 |
|---|---|---|
| committer | alemi <me@alemi.dev> | 2023-03-12 03:42:32 +0100 |
| commit | abbaac1fe2bbe88673e0798432b2d84e43bb7032 (patch) | |
| tree | c0ff0c64f03db27c98744f2ae3b84b00dc55598f /README.md | |
| parent | 9eab4544b0040417cd7a51a5be300b9ac940871f (diff) | |
docs: updated README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -1,11 +1,24 @@ # BSCV + This is our next generation Minecraft utility mod, built from scratch. Its aim is to be lightweight, minimal but complete and powerful tools for technic servers. +## Features +Only basic modules are implemented as of now, but already enough to provide some useful tools. + +## Architecture +BSCV tries to not reinvent the wheel whenever possible. It's built on top of Forge config system and Brigadier command system. + +To provide advanced patching capabilities, BSCV uses direct ASM patching over Mixins. Patching is built on top of [lll](https://git.fantabos.co/lillero/about). + +There is no GUI, but all config options can be changed with any mod implementing a GUI for Forge configs, such as [this one](https://www.curseforge.com/minecraft/mc-mods/config-menus-forge). + ## Release Find most recent auto-built releases [here](https://data.fantabos.co/bscv/). +Check this repository tags for changelogs and relevant notes. + ## Fairness -This mod contains many ways to make the fame unfairly easier. Using this to gain competitive advantage is surely unfair, but playing with friends can be fine if clarified upfront. +This mod contains many ways to make the game easier. Using this to gain competitive advantage is surely unfair, but playing with friends can be fine if clarified upfront. ### Testing it out Come test it out on `fantabos.co` server, where everything is allowed. |