NeoWave Lua 🌊

---

🔹 Overview

NeoWave Lua is a modular terminal system tool for Neofetch/Fastfetch customization. It is the successor to the Bash legacy version, designed for maximum flexibility:

• Custom ASCII logos (distro-based or your own)
• Multi-color terminal output with full override support
• Module-based info display (CPU, GPU, MEM, OS, etc.)
• Preview, Apply, and Revert actions
• Cross-platform modularity (Linux-based terminals)

NeoWave Lua is designed for power users, terminal enthusiasts, and sysadmins who want precise control over Neofetch/Fastfetch output, without modifying source files manually.

---

💎 Features

• Module overrides: Control which info modules are displayed and their formatting.
• Contains every neofetch distro logo and variants including, small, old, and ubuntu varieties.
• Legacy support: Fully documents Bash version differences; Lua version adds flexibility and polish.
• Custom ASCII, PNG, and GIF logos – fully displayable in the terminal with live resizing and color adaptation.
• OS & system component spoofing – fake your OS, CPU, GPU, and memory stats for testing or demos, with the ability to revert to real values.
• Dynamic color tables – define your own palettes for ASCII, PNG/GIF logos, and info modules directly in Lua; no external color preset files required.
• Modular info modules – toggle which system info to display (CPU, memory, disk, network, etc.) per session.
• Preview, Apply, and Revert – safely test changes, apply your configuration, or revert to the original Neofetch config.
• Backup system – automatically saves the original Neofetch config and previous NeoWave configs for full safety.
• Custom logo support – easily add your own logos to ~/.config/neowave/ascii/custom and select them on demand.
• Flexible alignment & right-side display – control info width, alignment, and spacing for a polished terminal layout.
• Cross-distro compatible – works on any Linux distro running Neofetch or Fastfetch.
• Lightweight & scriptable – fully written in Lua for speed, readability, and easy customization.

---

📦 Dependencies

Image Rendering support requires one of the following tools to be installed:

• chafa
• viu
• img2txt

Arch / Manjaro

• Update your system first

sudo pacman -Syu

• Install chafa, viu, and caca-utils (img2txt)

sudo pacman -S chafa viu caca-utils

Ubuntu / Debian

• Update your package list

sudo apt update

• Install chafa, viu, and caca-utils (img2txt)

sudo apt install chafa viu caca-utils -y

If none are installed NeoWave automatically falls back to standard ASCII logos.

---

📂 File Structure

• ~/.config/neowave-lua/
• ├── ascii/ # ASCII logos
• │ ├── custom/ # User-added custom ASCII logos
• │ └── distro/ # Live previews for distro logos
• ├── backup/ # Automatically saved previous configs
• ├── colors/ # Optional Lua tables for color palettes
• ├── core/ # Core engine scripts (Lua modules)
• │ ├── ascii.lua # ASCII Loader and renderer (Populates data/ascii/)
• │ └── engine.lua # Everything: apply, backup, colors, logos, state
• ├── menu.lua # CLI menu interface
• ├── data/
• │ ├──distros.lua # Table of applicable stock distros(EVERY applicable distro included)
• │ └── ascii/ # ASCII cache folder
• │ ├──arch.txt
• │ ├──ubuntu.txt
• │ └── etc...
• ├── profiles/
• ├── stock_configs/
• ├── theme/
• ├── neowave.lua # Entrypoint script; run neowave from terminal
• └── README.md # You are here!

Note: Unlike the Bash version, Lua does not require a temporary config file. All tables and memory-based settings are handled dynamically.

---

⚡ Installation

1. Clone This repo

git clone https://github.com/ethanlabs101/neowave-lua.git ~/.config/neowave-lua

2. Optional - Install Dependencies for PNG/GIF render support (see dependencies)

3. Install lua (5.4)

Arch / Manjaro

sudo pacman -Syu lua

Ubuntu / Debian

sudo apt update
sudo apt install lua5.4

4. Install luarocks / luafilesystem (for read/write config purposes)

Arch / Manjaro

sudo pacman -Syu luarocks

sudo luarocks install luafilesystem

Ubuntu / Debian

sudo apt update
sudo apt install luarocks -y

sudo luarocks install luafilesystem

5. Launch NeoWave:

lua ~/.config/neowave-lua/neowave.lua

Arch's lua package currently provides lua 5.4

🛠 Usage

• Preview configuration: see how colors, logos, and modules render in your terminal
• Apply configuration: save your settings to active Neofetch/Fastfetch config
• Revert configuration: restore from backup to undo changes

Advanced Options

• Toggle OS and hardware spoofing
• Use custom ASCII/PNG/GIF logos
• Modify colors dynamically via Lua tables in colors/

---

💻 Contributing

NeoWave Lua is open for contributions! You can help by:

• Adding new ASCII, PNG, or GIF logos
• Expanding fully customized presets
• Creating new info modules
• Optimizing rendering and menu interaction

---

• 🎯 Legacy Bash vs NeoWave Lua Comparison

Feature / Aspect	Bash Version (Legacy)	Lua Version (Current)
Language & Engine	Bash scripts	Lua 5.4, modular engine
Config Handling	Temporary config files, mostly linear	True modular configs, no tmp files needed, easier to extend
Custom ASCII Art	Works, but limited; no dynamic previews	Full custom ASCII + PNG/GIF support, live previews
Color Management	Color presets as separate scripts	Full color tables, dynamic overrides per module, easier to tweak
OS / Specs Spoofing	Not supported	Can spoof OS, CPU, GPU, memory, with toggles
Module System	Hardcoded; adding/removing modules is tedious	Modular: enable/disable modules on the fly, fallback system
Fast Fetch / Expansion	Limited	Structured for future Fastfetch support, easy to extend
Backup & Revert	Manual backups of neofetch configs	Automatic backup & revert system for original configs
File Structure	Complex: multiple shell scripts scattered in subfolders	Simplified modular Lua structure, easier to maintain
Extensibility	Hard to extend, requires deep Bash knowledge	Easy to extend with Lua, can integrate new terminal features, PNG/GIF, OS spoofing, modules

• See Legacy Bash Version:
• Neowave Bash Legacy

Summary: The Lua version isn’t just a port — it’s a modular, future-proof engine. It keeps everything from the Bash version but adds live previews, better color handling, OS/spec spoofing, PNG/GIF support, module toggling, and automated backup/revert. Bash was great for legacy experimentation, but Lua is the clean, maintainable, and fully extensible successor.

---

📄 License

This project is licensed under the MIT License — see LICENSE for details.

---

🌐 Contact

---

NeoWave Lua is designed for educational, customization, and system exploration purposes. Use responsibly.