From 0fdb0405b6567aed4cd00637f79410ceeafd2e3b Mon Sep 17 00:00:00 2001 From: roy Date: Mon, 29 Jun 2026 21:32:00 +0300 Subject: Added background color options. Added README.md. --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b5a10e --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Introduction + +This is a small C++ library with small methods to change the behaviour and colors of the terminal. + +# Usage + +Import normally with: + + +```#include "terminal-game-utils.hpp"``` +``` +``` + +And use tgu:: to refer to the methods/enum in the library. + +## API: + +Enum GameKey - Arrow keys, space, escape, A-Z. +GetKeyPress() - Only works if raw mode is enabled. Retrieves the next key pressed, trying to parse the bytes to one of the options available in GameKey. +Enable/DisableRawMode() - Enable/disable raw mode (take input by bytes, without waiting for a newline/enter). +Enter/LeaveGameBuffer() - Enable a temporary buffer for drawing the game. +TextGreen/Red/Blue - Change the text/foreground to one of 3 colors. +TextRGB(int r, int g, int b) - Change the text/foreground to any RGB color. +BGGreen/Red/Blue - Change the background to one of 3 colors. +BGRGB(int r, int g, int b) - Change the background to any RGB color. +TerminalColorReset - Resets foreground AND background to defaults. +MoveCursor(int row, int col) - Moves cursor to a specific row and column. + +Feel free to use this anywhere at all. -- cgit v1.3.1