Basalt2/docs/home.md

Welcome to The Basalt Wiki

Basalt is a user-friendly UI framework for CC:Tweaked (also known as "ComputerCraft: Tweaked") - a popular Minecraft mod. It was developed to enhance user interaction through visual displays.

Installation

wget run https://raw.githubusercontent.com/Pyroxenium/Basalt2/main/install.lua

Features

• Pre-built Components: Buttons, Lists, Textboxes, and more
• Modern UI: Animations, themes, states, xml
• Event System: Powerful event handling
• Plugin System: Extend Basalt with custom plugins
• Developer Friendly:
  • Type definitions for better IDE support
  • Extensive documentation
  • Minification support

Quick Start

local basalt = require("basalt")

-- Create a simple UI
basalt.getMainFrame()
    :addButton()
    :setText("Hello Basalt!")
    :setPosition(5, 5)
    :onMouseClick(function()
        -- Your code here
    end)

basalt.run()

Preview

Documentation

• Getting Started Guide
• API Reference

Community & Support

• Report bugs on GitHub
• Join our Discord
• Ask questions on GitHub Discussions
• Check out the FAQ