Aptivi - Deprecated Manuals
ProjectsWebsiteBlog
Terminaux 3.x - Manual
Terminaux 3.x - Manual
  • 👋Welcome!
  • 🥛Breaking changes
    • ⬆️API v1.0
    • ⬆️API v2.0
    • ⬆️API v3.0
  • Usage
    • 💡Preface
    • 🖥️Console Tools
      • ✅Console Checker
        • ☑️Console Size Requirements
      • 🔌Console Wrapper
      • 🖊️Console Writers
      • 🌈Console Colors
      • 🖼️Color Templates
      • 📺Console Screen
      • ☎️Console Resize Listener
      • 📽️Presentation System
      • 🎚️VT Sequences
      • ➕Console Extensions
      • ⌨️Interactive TUI
    • 📖Input Reader
      • ⌨️Keybindings
      • 🔌Custom bindings
      • ✔️Reader State
      • ⚙️Reader Settings
      • 🔦Syntax Highlighting
      • 🖱️Pointer Events
      • ✍️Other Input
        • 🖊️Figlet Font Selector
        • 🎨Color Wheel
    • 🎨Color Sequences
      • ⛱️Color Model Conversions
      • 🧭Color Model Parsing
      • 🖌️Interop with System.Drawing.Color
  • Report an issue
  • Source code
  • Our projects
  • API Reference
Powered by GitBook
On this page
  • Reading an input
  • Other console tools
  • Trying Terminaux out
Edit on GitHub
  1. Usage

Preface

How do you use it?

Last updated 1 year ago

To use this library, you first need to know exactly why do you need to install Terminaux into your console application. If your application is intended to be an interactive one, or if your application shows graphics (text, info box, ...), then Terminaux is the right library for you.

Terminaux provides several terminal actions, like reading an input (was on TermRead), getting color information (was on ColorSeq), and using VT sequences and filtering them (was on VT.NET).

Reading an input

To get started reading input, follow the below page to get started:

Other console tools

For other console tools that Terminaux provides, you can access the below page:

Trying Terminaux out

Each version of Terminaux contains their own release page that allows you to download a demo zip file from GitHub. This allows you access to the interactive demo, which allows you to try almost all Terminaux features out, including the interactive TUI, the terminal reader, and so on.

This demo can be used as a test to verify that your console works as expected and that it supports all the features that Terminaux requires.

Any call to any function that require VT sequences and advanced console features, such as fancy writers and mouse pointer events, will cause Terminaux to check your console.

💡
📖Input Reader
🖥️Console Tools