12 releases

✓ Uses Rust 2018 edition

0.3.0 Jan 20, 2019
0.2.1 Jan 12, 2019
0.1.8 Mar 22, 2018

#7 in Rendering engine

Download history 6/week @ 2019-04-14 13/week @ 2019-04-21 26/week @ 2019-04-28 15/week @ 2019-05-05 23/week @ 2019-05-12 29/week @ 2019-05-19 36/week @ 2019-05-26 25/week @ 2019-06-02 12/week @ 2019-06-09 33/week @ 2019-06-16 63/week @ 2019-06-23 61/week @ 2019-06-30 36/week @ 2019-07-07 13/week @ 2019-07-21

108 downloads per month

MIT license

235KB
4.5K SLoC

GLerminal, an OpenGL terminal

Build Status Docs Crates.io

Read our Code of Conduct and join our Discord server if you want to chat!

A lightweight terminal made with OpenGL from the ground-up.
With this terminal, you're able to make the terminal applications or games you've always wanted, but with a terminal that looks the same for everyone, because it's made with OpenGL and doesn't use the computer's native terminal!

Currently supported features include:

  • Moving the cursor within the Terminal
  • Changing foreground and background colors to whatever you want!
  • Shaking text
  • A text-parser that will make it easy to write whatever you want and make it look cool!
    • Parseable text example: "Hello, [fg=red]this is red[/fg] and [shake=1.0]this is shaking[/shake]."
  • Drawing of multiple text buffers (grids of text) on top of eachother
  • A menu system that allows for easy creation and usage of menus for selecting and pressing stuff! (See docs for more)
    • Requires the menu_systems optional feature to be enabled
  • Write any characters up to 16-bits that your font supports

Note: Requires OpenGL 3.3+ support

Table of Contents

How to use

Extensive documentation can be found at: docs.rs.

Just add the following line to your Cargo.toml:

[dependencies]
glerminal = "0.3"

And then using this crate is quite simple:

extern crate glerminal; // Not required if running 2018 edition

use glerminal::terminal::TerminalBuilder;
use glerminal::text_buffer::TextBuffer;

fn main() {
    let terminal = TerminalBuilder::new()
        .with_title("Hello GLerminal!")
        .with_dimensions((1280, 720))
        .build();
    let mut text_buffer;
    match TextBuffer::create(&terminal, (80, 24)) {
        Ok(buffer) => text_buffer = buffer,
        Err(error) => panic!(format!("Failed to initialize text buffer: {}", error)),
    }

    text_buffer.write("Hello, GLerminal!");
    terminal.flush(&mut text_buffer);

    while terminal.refresh() {
        terminal.draw(&text_buffer);
    }
}

What the example looks like

Custom font?

The default font that comes with GLerminal is a render of Source Code Pro and only includes a few more popular unicode blocks, to save space on the end product (the default font is compiled into the library).
The following blocks are included in the default font:

To make a custom font, you have to use either the BMFont standard / .fnt, or .sfl, and software that can produce such files are BMFont (can produce only .fnt), or Fontbuilder (can produce both).
The font image needs to be RGBA PNG.

It is advised to use Fontbuilder, as (at least after some testing) the png font images generated by BMFont (and their antialiasing) are sub-par compared to Fontbuilder, though Fontbuilder might be difficult to build on windows devices (It is possible with MinGW though).

Note If using Fontbuilder, it is highly recommended to use this fork as it contains a critical fix for .sfl font exporting.

After that it is advisable to look at glerminal font documentation on how a custom font is then loaded to use.

Contributing & Code of Conduct

You are welcome to contribute to this project, but before do review the Contributing guidelines.

A Code of Conduct can also be found in the repository as CODE_OF_CONDUCT.md, please review it before interacting with the community.

License

This crate is distributed under the terms of the MIT License.
This crate also uses a font as a default font, called Source Code Pro, which is distributed under the terms of SIL OFL Version 1.1.

Dependencies

~1.7–3.5MB
~68K SLoC