README
¶
gorain 🌧️
Get a rainy vibe in your terminal
Inspired by rmaake1's rain project
You should check out his awesome creation!
Code Preview
Calm Rain
Thunderstorm
Yes, all done with Termux :)
⚙️ Features
- Customizable colors for raindrops and lightning 🌩️
- Thunderstorm Mode - toggle for intense rain and epic lightning bursts!
- Snowfall Mode - toggle for a calm snowfall scene ❄️
- Night Mode - toggle for a starry night sky with a moon! Stars will twinkle faintly.
- Responsive design - works on various terminal sizes and devices (e.g. Termux, etc)
- Lightweight & fast - pure Go, no external dependencies
- Vibes included - cuz why not :)
🚀 Installation
Requires Go 1.20+ - make sure you have Go installed:
go version
If not, run:
1. Linux 🐧
- Debian / Ubuntu
sudo apt update
sudo apt install golang -y
- Arch / Manjaro
sudo pacman -S go
- Termux (Android)
pkg update
pkg install golang
2. macOS 🍎
- With Homebrew
brew install go
📦 Manual Installer
- Visit > https://go.dev/DL
- Download the
.pkgfile - Run the installer and follow instructions ✅ Then open Terminal:
go version
3. Windows 🪟
📦 Using Installer
- Go to > https://go.dev/DL
- Download the
.msifile - Run it and follow the instructions
- Restart Command Prompt / PowerShell ✅ Then test:
go version
⚒️ Common Troubleshooting
Go not found?
Make sure Go's bin folder is in your system PATH
Example (Linux/Termux):
export PATH=$PATH:$HOME/go/bin
Windows:
- Open "System Environment Variables"
- Edit
PATHand add:C:\Go\bin
✅ Verify Installation
After setup, run:
go version
You should see something like:
go version go1.21.0 linux/amd64
💡 Tip
Use go env to see all Go paths and config:
go env
Now to the fun part :)
⚒️ Using go install (recommended)
if you have Go installed, you can install gorain directly from the terminal:
go install github.com/GopherParrot/gorain@latest
Then run it with:
gorain
To be able to run your Go program from anywhere in the terminal,you need to make sure this folder is in your system's PATH:
$GOPATH/bin
Or if you never change your GOPATH, it's usually:
$HOME/go/bin
⚒️ How to add Go to PATH
1. Linux /macOS / Termux:
Add this line to your shell config (like .bashrc, .zshrc, or .profile):
export PATH="$HOME/go/bin:$PATH"
Then run:
source ~/.bashrc # or .zshrc, depending on your shell
2. Windows:
- Search for "Environment Variables" in Start menu
- Click "Edit environment variables for your account"
- Under User variables, find or create a
PATHvariable - Add this path:
C:\Users\<YourUsername>\go\bin
- Click OK, restart terminal ✅
Once you do that, you'll be able to just type:
gorain
from anywhere 😁
How to Use
After installing, just run:
gorain
Controls
| Key | Action |
|---|---|
| t/T | Toggle Thunderstorm mode ⛈️ |
| s/S | Toggle Snowfall mode 🌨️ |
| n/N | Toggle Night mode (moon & stars) 🌙✨ |
| h/H | Toggle hiding all weather effects (useful for viewing just the night sky) |
| q/Q/Esc/Ctrl+C | Quit the program |
Command-line options
gorain [OPTIONS]
| Option | Description | Default |
|---|---|---|
| --rain-color [COLOR] | Set the color of the raindrops | Cyan |
| --lightning-color [COLOR] | Set the color of the lightning | Yellow |
| --snow-color [COLOR] | Set the color of the snowflakes | White |
| --moon-color [COLOR] | Set the color of the moon | Yellow |
| --moon-char [CHAR] | Set the character used for the moon | # |
| --help | Show help message and exit | -- |
Available colors:
black,red,green,yellow,blue,magenta,cyan,white
Example:
gorain --rain-color green --lightning-color white
Thanks for spending your time reading this :)
Documentation
¶
There is no documentation for this package.