# Basalt 2 - A UI Framework for CC:Tweaked

![GitHub Repo stars](https://img.shields.io/github/stars/Pyroxenium/Basalt2?style=for-the-badge)
[![Discord](https://img.shields.io/discord/976905222251233320?label=Discord&style=for-the-badge)](https://discord.gg/yNNnmBVBpE)

Welcome,

This is a complete rework of [Basalt](https://github.com/Pyroxenium/Basalt). There are many new features, including auto-generated LuaLS annotations and auto-generated documentation, ensuring that everything is always up-to-date.

Basalt is a UI framework designed for [CC:Tweaked](https://tweaked.cc/) - a popular Minecraft mod. For more information about CC:Tweaked, check out the project's [wiki](https://tweaked.cc/) or download it from [Modrinth](https://modrinth.com/mod/cc-tweaked) or [CurseForge](https://www.curseforge.com/minecraft/mc-mods/cc-tweaked).

## Documentation

For detailed documentation, examples, and guides, visit our documentation on [basalt.madefor.cc](https://basalt.madefor.cc/).

## Support

If you need help or have questions:
- Check the [documentation](https://basalt.madefor.cc/).
- Join our [Discord](https://discord.gg/yNNnmBVBpE).
- Report issues or contribute on [GitHub](https://github.com/Pyroxenium/Basalt2/issues).

## License

This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

## Demo

![Demo of Basalt](https://raw.githubusercontent.com/Pyroxenium/Basalt/master/docs/_media/basaltPreview2.gif)