sysc-Go

module
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 13, 2025 License: MIT

README

sysc-Go

Terminal animation library for Go. Pure Go animations ready to use in your TUI applications.

Effects

  • Rain Effect - ASCII character rain effect
  • Matrix Rain - Classic Matrix digital rain
  • Fireworks - Particle-based fireworks display
  • Fire Effect - DOOM PSX-style fire animation
  • Pour Effect - Characters pour into position from different directions
  • Beams Effect - Full-screen light beam background animation
  • Beam Text Effect - Text display with animated light beams and auto-sizing
  • Ring Text Effect - Text rotates and converges in spectacular ring animation
  • Blackhole Effect - Text gets consumed by a swirling blackhole and explodes
  • Blackhole Particles - Pure particle blackhole effect with random stars (no text)
  • Aquarium - Underwater scene with fish, diver, boat, and sea life
  • Print Effect - Typewriter-style text rendering
  • Rain Art - ASCII art with crystallizing rain effect
  • Matrix Art - ASCII art with Matrix-style digital streams

Installation

CLI Tools

Via one-line installer (fastest):

curl -fsSL https://raw.githubusercontent.com/Nomadcxx/sysc-Go/master/install.sh | sudo bash

Via interactive installer:

# Clone and run the TUI installer (requires sudo for system-wide installation)
# Installs both syscgo and syscgo-tui binaries
git clone https://github.com/Nomadcxx/sysc-Go.git
cd sysc-Go
sudo go run ./cmd/installer/

Via AUR (Arch Linux):

yay -S syscgo

Via Go:

go install github.com/Nomadcxx/sysc-Go/cmd/syscgo@latest
go install github.com/Nomadcxx/sysc-Go/cmd/syscgo-tui@latest

As Library

go get github.com/Nomadcxx/sysc-Go

Quick Start

Interactive TUI

The easiest way to browse and select animations is through the interactive TUI:

syscgo-tui

Visual selector for animations, themes, and durations. Built-in ASCII art editor with live preview (Ctrl+S). Navigate with arrows or vim keys.

Command Line

Run any animation directly from command line:

# Rain effect with Tokyo Night theme
syscgo -effect rain -theme tokyo-night

# Matrix rain with Nord theme for 30 seconds
syscgo -effect matrix -theme nord -duration 30

# Fire effect with Dracula theme (infinite loop)
syscgo -effect fire -theme dracula -duration 0

# Pour effect with Tokyo Night theme
syscgo -effect pour -theme tokyo-night -duration 10

# Beams effect with Nord theme (full-screen background)
syscgo -effect beams -theme nord -duration 0

# Beam text effect with auto-sizing and display mode
syscgo -effect beam-text -theme nord -file message.txt -auto -display -duration 5

# Aquarium effect with Dracula theme (infinite)
syscgo -effect aquarium -theme dracula -duration 0

# Blackhole particles effect with Eldritch theme (dramatic full-screen particle animation)
syscgo -effect blackhole-particles -theme eldritch -duration 0

Available themes: dracula, gruvbox, nord, tokyo-night, catppuccin, material, solarized, monochrome, transishardjob, rama, eldritch, dark

Beam Text Special Flags

The beam-text effect supports two special flags:

  • -auto - Automatically sizes the canvas to fit text dimensions exactly
  • -display - Completes animation once and holds at final bright state

Example:

syscgo -effect beam-text -file ~/header.txt -auto -display -theme nord -duration 5

Effect Showcase

Rain

ASCII Rain

Matrix

Matrix Rain

Fireworks

Fireworks

Fire

Fire Effect

Decrypt

Decrypt Effect

Pour

Pour Effect

Beams

Beams Effect

Beam Text

Beam Text Effect

Aquarium

Aquarium Effect

Print

Print Effect

Demo

Run the interactive demo to see all animations:

cd examples/demo
go run .

Documentation

See GUIDE.md for detailed CLI usage.

Inspiration

This project was inspired by terminaltexteffects - an amazing Python library for terminal visual effects. sysc-Go brings similar visual effects to the Go ecosystem with a focus on performance and easy integration into Go TUI applications.

License

MIT

Directories

Path Synopsis
Package animations provides terminal animation effects for Go applications.
Package animations provides terminal animation effects for Go applications.
cmd
flf2bit command
installer command
syscgo command
syscgo-tui command
simple command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL