{"id":15054632,"url":"https://github.com/teascade/glerminal","last_synced_at":"2025-04-10T03:03:20.247Z","repository":{"id":57633880,"uuid":"125099283","full_name":"Teascade/glerminal","owner":"Teascade","description":"A lightweight terminal made with OpenGL","archived":false,"fork":false,"pushed_at":"2019-12-21T20:25:28.000Z","size":1146,"stargazers_count":25,"open_issues_count":14,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-02T18:26:29.259Z","etag":null,"topics":["opengl","rust","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Teascade.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-13T18:48:58.000Z","updated_at":"2021-11-17T15:38:50.000Z","dependencies_parsed_at":"2022-09-07T04:00:55.639Z","dependency_job_id":null,"html_url":"https://github.com/Teascade/glerminal","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teascade%2Fglerminal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teascade%2Fglerminal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teascade%2Fglerminal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Teascade%2Fglerminal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Teascade","download_url":"https://codeload.github.com/Teascade/glerminal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239126447,"owners_count":19586097,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["opengl","rust","terminal"],"created_at":"2024-09-24T21:38:50.169Z","updated_at":"2025-02-16T11:32:15.839Z","avatar_url":"https://github.com/Teascade.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GLerminal, an OpenGL terminal\n[![Build Status](https://travis-ci.org/Teascade/glerminal.svg?branch=0.3.0-fix)](https://travis-ci.org/Teascade/glerminal)\n[![Docs](https://docs.rs/glerminal/badge.svg)](https://docs.rs/glerminal)\n[![Crates.io](https://img.shields.io/crates/v/glerminal.svg)](https://crates.io/crates/glerminal)\n\n\nRead our [Code of Conduct](CODE_OF_CONDUCT.md) and join our [Discord server](https://discord.gg/Wg6D2Rk) if you want to chat!\n\nA lightweight terminal made with OpenGL from the ground-up.  \nWith 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!\n\nCurrently supported features include:\n- Moving the cursor within the Terminal\n- Changing foreground and background colors to whatever you want!\n- Shaking text\n- A text-parser that will make it easy to write whatever you want and make it look cool!\n  - Parseable text example: `\"Hello, [fg=red]this is red[/fg] and [shake=1.0]this is shaking[/shake].\"`\n- Drawing of multiple text buffers (grids of text) on top of eachother\n- A menu system that allows for easy creation and usage of menus for selecting and pressing stuff! (See docs for more)\n  - Requires the `menu_systems` optional feature to be enabled\n- Write any characters up to 16-bits that your font supports\n  \n***Note: Requires OpenGL 3.3+ support***\n\n### Table of Contents\n- [How to use](#how-to-use)\n- [Custom font?](#custom-font)\n- [Contributing \u0026 Code of Conduct](#contributing-\u0026-code-of-conduct)\n- [License](#license)\n\n### How to use\nExtensive documentation can be found at: [docs.rs][docs].\n\nJust add the following line to your `Cargo.toml`:\n```toml\n[dependencies]\nglerminal = \"0.3\"\n```\n\nAnd then using this crate is quite simple:\n```rust\nextern crate glerminal; // Not required if running 2018 edition\n\nuse glerminal::terminal::TerminalBuilder;\nuse glerminal::text_buffer::TextBuffer;\n\nfn main() {\n    let terminal = TerminalBuilder::new()\n        .with_title(\"Hello GLerminal!\")\n        .with_dimensions((1280, 720))\n        .build();\n    let mut text_buffer;\n    match TextBuffer::create(\u0026terminal, (80, 24)) {\n        Ok(buffer) =\u003e text_buffer = buffer,\n        Err(error) =\u003e panic!(format!(\"Failed to initialize text buffer: {}\", error)),\n    }\n\n    text_buffer.write(\"Hello, GLerminal!\");\n    terminal.flush(\u0026mut text_buffer);\n\n    while terminal.refresh() {\n        terminal.draw(\u0026text_buffer);\n    }\n}\n```\n\n![What the example looks like](images/example_screenshot.png)\n\n### Custom font?\nThe default font that comes with GLerminal is a render of [Source Code Pro][scp_font] and only includes a few more popular unicode blocks, to save space on the end product (the default font is compiled into the library).  \nThe following blocks are included in the default font:\n- [`Basic latin`][basic_latin]\n- [`Latin-1 supplement`][latin_1_supplement]\n- [`Latin Extended-A`][latin_extended_a]\n- [`Currency Symbols`][currency_symbols]\n- [`Box Drawing`][box_drawing]\n- [`Block Elements`][block_elements]\n\nTo make a custom font, you have to use either the [`BMFont standard / .fnt`][bmfont_standard], or `.sfl`, \nand software that can produce such files are [BMFont][bmfont] (can produce only `.fnt`), or [Fontbuilder][fontbuilder] (can produce both).  \nThe font image **needs** to be RGBA PNG.\n\nIt is advised to use [Fontbuilder][fontbuilder], as (at least after some testing) the png font images generated by [BMFont][bmfont] (and their antialiasing) are sub-par compared to [Fontbuilder][fontbuilder], though Fontbuilder might be difficult to build on windows devices (It is possible with MinGW though).\n\n**Note** If using Fontbuilder, it is highly recommended to use [this fork][teascade_fontbuilder] as it contains a critical fix for .sfl font exporting.\n\nAfter that it is advisable to look at glerminal [font documentation][font_docs] on how a custom font is then loaded to use.\n\n### Contributing \u0026 Code of Conduct\nYou are welcome to contribute to this project, but before do review the [Contributing guidelines](CONTRIBUTING.md).\n\nA Code of Conduct can also be found in the repository as [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), \nplease review it before interacting with the community.\n\n### License\nThis crate is distributed under the terms of [the MIT License][license].  \nThis crate also uses a font as a default font, called [Source Code Pro][scp_font], which is distributed under the terms of [SIL OFL Version 1.1][scp_license].\n\n[docs]: https://docs.rs/glerminal\n[license]: LICENSE.md\n[scp_font]: https://github.com/adobe-fonts/source-code-pro\n[scp_license]: LICENSE_SOURCE_CODE_PRO.md\n[bmfont]: http://www.angelcode.com/products/bmfont/\n[bmfont_standard]: http://www.angelcode.com/products/bmfont/doc/render_text.html\n[fontbuilder]: https://github.com/andryblack/fontbuilder\n[teascade_fontbuilder]: https://github.com/Teascade/fontbuilder\n[font_docs]: https://docs.rs/glerminal/0.3.0/glerminal/struct.Font.html\n\n[basic_latin]: https://en.wikipedia.org/wiki/Basic_Latin_(Unicode_block)\n[latin_1_supplement]: https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)\n[latin_extended_a]: https://en.wikipedia.org/wiki/Latin_Extended-A\n[currency_symbols]: https://en.wikipedia.org/wiki/Currency_Symbols_(Unicode_block)\n[box_drawing]: https://en.wikipedia.org/wiki/Box_Drawing\n[block_elements]: https://en.wikipedia.org/wiki/Block_Elements","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteascade%2Fglerminal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteascade%2Fglerminal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteascade%2Fglerminal/lists"}