License: MIT Terminal Go Discord

Features • Quick Start • Installation • Usage • Library • Font Collection • Contributing • License • Acknowledgments

✨ Features

🚀 Quick Start

# 1. Clone the repository
git clone https://github.com/superstarryeyes/bit
cd bit
# 2. Install dependencies
go mod tidy
# 3. Build the interactive UI
go build -o bit ./cmd/bit
# 4. Start creating!
./bit

📦 Installation

Quick Install (Linux/macOS)

curl -sfL https://raw.githubusercontent.com/superstarryeyes/bit/main/install.sh | sh

Manual Installation

# Linux/macOS
tar -xzf bit_*_Linux_x86_64.tar.gz
sudo mv bit /usr/local/bin/
# Windows (PowerShell)
Expand-Archive bit_*_Windows_x86_64.zip
# Move bit.exe to your PATH

Build from Source

# Clone repository
git clone https://github.com/superstarryeyes/bit
cd bit
# Build the binary
make build
# Or manually
go build -o bit ./cmd/bit

Note

Fonts are embedded using go:embed, ensuring the binaries are fully self-contained.

💻 Usage

Running Bit

# Start interactive UI
bit
# CLI mode - quick render
bit "Hello World"
# CLI mode - with options
bit -font ithaca -color 31 "Red Text"
# List all fonts
bit -list
# Load custom font or directory of fonts (along with built-in fonts)
bit -load ./myfont.bit
bit -load ./fonts/
# Show help
bit -help

Interactive UI - Keyboard Controls

Control Panels

1. 🔴 Text Input Panel (2 modes)

2. 🟢 Font Selection Panel

3. 🔵 Spacing Panel (3 modes)

4. 🟡 Color Panel (3 modes)

5. 🟣 Text Scale Panel

6. ⚫ Shadow Panel (3 modes)

Warning

If shadows are enabled with half-pixel characters, a warning appears in the title bar. The library automatically disables shadows in this case to prevent visual artifacts.

CLI Mode

Basic Commands

# Render text with default settings
bit "Hello"
# List all available fonts
bit -list
# Use specific font and color (ANSI code)
bit -font ithaca -color 31 "Red"
# Use specific font and color (hex code)
bit -font ithaca -color "#FF0000" "Red"
# Gradient text with ANSI codes
bit -font dogica -color 31 -gradient 34 -direction right "Gradient"
# Gradient text with hex codes
bit -font dogica -color "#FF0000" -gradient "#0000FF" "Gradient"
# Text with shadow
bit -font larceny -color 94 -shadow -shadow-h 2 -shadow-v 1 "Shadow"
# Scaled text
bit -font pressstart -color 32 -scale 1 "2X"
# Aligned text
bit -font gohufontb -color 93 -align right "Go\nRight"

CLI Options

Available Colors

Tip

The CLI and library support any hex color (e.g., -color "#FF5733"), providing unlimited color possibilities beyond the ANSI palette.

📚 Library

Quick Library Example

package main
import (
	"fmt"
	"github.com/superstarryeyes/bit/ansifonts"
)
func main() {
	// Load a font
	font, err := ansifonts.LoadFont("ithaca")
	if err != nil {
		panic(err)
	}
	// Advanced rendering with options
	options := ansifonts.RenderOptions{
		CharSpacing: 3,
		WordSpacing: 3,
		LineSpacing: 1,
		TextColor: "#FF0000",
		GradientColor: "#0000FF",
		UseGradient: true,
		GradientDirection: ansifonts.LeftRight,
		Alignment: ansifonts.CenterAlign,
		ScaleFactor: 1.0,
		ShadowEnabled: true,
		ShadowHorizontalOffset: 2,
		ShadowVerticalOffset: 1,
		ShadowStyle: ansifonts.MediumShade,
	}
	// Validate options before rendering (optional - render functions validate automatically)
	if err := options.Validate(); err != nil {
		fmt.Printf("Invalid options: %v\n", err)
		return
	}
	rendered := ansifonts.RenderTextWithOptions("Hello", font, options)
	for _, line := range rendered {
		fmt.Println(line)
	}
}

Tip

See the ansifonts library documentation for detailed API reference and examples.

🗂️ Font Collection

{
 "name": "Font Name",
 "author": "Author Name",
 "license": "License Type",
 "characters": {
 "A": ["line1", "line2", ...],
 "B": ["line1", "line2", ...],
 ...
 }
}

Note

Each font file contains a license field indicating its specific license terms. All fonts are under permissive open-source licenses, which allow free usage, modification, and distribution for both personal and commercial purposes.

Export Formats

🛠️ Contributing

📄 License

🙏 Acknowledgments

⭐ Star this repo if you find it useful!