<div align="center"> <img src="docs/assets/images/zerotty.png" alt="ZeroTTY Logo"> <h1>ZeroTTY</h1> <p> <b>A high-performance, cross-platform terminal emulator built with Zig.</b> </p> <p> <a href="https://github.com/PaNDa2code/zerotty/actions/workflows/test.yml"><img src="https://raw.githubusercontent.com/PaNDa2code/zerotty/badges/.badges/master/badges/test-x86_64-linux-gnu.svg" alt="Linux Test Status"></a> <a href="https://github.com/PaNDa2code/zerotty/actions/workflows/test.yml"><img src="https://raw.githubusercontent.com/PaNDa2code/zerotty/badges/.badges/master/badges/test-x86_64-windows-gnu.svg" alt="Windows Test Status"></a> </p> </div>

ZeroTTY is a modern terminal emulator designed for speed, efficiency, and cross-platform compatibility. By leveraging the power of Zig and a low-level design, ZeroTTY aims to provide a native, high-performance experience with minimal dependencies.

⚠️ This project is currently in an early stage of development.
Expect bugs, missing features, and fast-moving changes

Features

Cross-Platform: Runs on Linux, Windows, and macOS.
Multiple Renderer Backends: Supports Vulkan and OpenGL.
High Performance: Built for speed and low resource usage.
Customizable: Configure fonts, colors, and more.
Minimal Dependencies: A lightweight and focused design.

Getting Started

Prerequisites

Zig: The project is built using the Zig compiler.
System Libraries: Additional system libraries may be required depending on your OS, chosen windowing system, and rendering backend (e.g., X11, xcb, xkbcommon, GL for Linux).

Building from Source

Clone the repository:

git clone https://github.com/PaNDa2code/zerotty.git
cd zerotty

Build the project:

You can build ZeroTTY with the following command:

zig build -Doptimize=ReleaseSafe

This will build it with the recommend options for your setup.

You can also specify the rendering backend:

# Build with OpenGL renderer
zig build -Doptimize=ReleaseSafe -Drender-backend=opengl

# Build with Vulkan renderer
zig build -Doptimize=ReleaseSafe -Drender-backend=vulkan

Also the window backend:

zig build -Dwindow-system=glfw

Run ZeroTTY:

After a successful build, the executable will be located in the zig-out/bin directory.

./zig-out/bin/zerotty

Contributing

Contributions are welcome! If you'd like to contribute to ZeroTTY, please follow these steps:

Fork the repository.
Create a new branch for your feature or bug fix.
Make your changes and commit them with a clear and descriptive message.
Push your changes to your fork.
Submit a pull request to the master branch of the original repository.

License

This project is under MIT license.

Zerotty

Install / Use

README