docs/versioned_docs/version-0.0.9/a_index.md

title, slug

title	slug
Introduction	/

OSUI is a powerful TUI library, what makes it special is it's design and features, it allows for both customization and easy of use.

Setup

First, you need to install osui to a already existing rust cargo project, then in your project directory run:

cargo add osui

Hello World App

To make a hello world app in OSUI simply write this

use osui::Screen;

fn main() -> std::io::Result<()> {
    let mut screen = Screen::new();
    
    screen.draw(format!("Hello, World!"));

    screen.run()
}

Hello World App With Velocity

The text will move from left to right with a velocity of 100

use osui::{Screen, extensions::velocity::{VelocityExtension, Velocity}};

fn main() -> std::io::Result<()> {
    let mut screen = Screen::new();
    screen.extension(VelocityExtension);
    
    screen
        .draw(format!("Hello, World!"))
        .component(Velocity(100, 0)); // Velocity(x, y)

    screen.run()
}