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

use osui::prelude::*;

fn main() -> std::io::Result<()> {
    let screen = Screen::new();

    rsx! {
        "Hello, World"
    }
    .draw(&screen);

    screen.run()
}

Hello World App With Velocity

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

use osui::prelude::*;

fn main() -> std::io::Result<()> {
    let screen = Screen::new();
    screen.extension(VelocityExtension);

    rsx! {
        @Velocity(100, 0);
        @Transform::new();
        "Hello, World"
    }
    .draw(&screen);

    screen.run()
}