razterizer / termin8or Goto Github PK

View Code? Open in Web Editor NEW

2.0 1.0 0.0 367 KB

A slimmed down curses-like header-only library. Good for terminal-based games and such.

License: MIT License

C++ 100.00%

ascii-art ascii-fonts console terminal terminal-based-game curses-library

termin8or's Introduction

Termin8or

This is a cross-platform header-only curses-like lib.

Showcases

Header Files

ASCII_Fonts.h : API for rendering text using FIGlet fonts and allows you to style your text with different colors. Supported FIGlet fonts are:
- Larry3D.
- SMSlant.
- Avatar.
Color.h : Contains colour definitions for the 16 colors that Termin8or (and the terminal) supports. There are also two transparency colours / modes which allows you to overlay text using the same colours that are already present in a given location in the screen buffer (see SpriteHandler.h).
Gradient.h : Allows you to access a vector of given objects using a normalized (0 to 1) t parameter. Useful for particle systems and things like that where it is used for color gradients.
Drawing.h : Features some drawing functions such as bresenham::plot_line(), drawing::draw_box(), drawing::draw_box_textured(), drawing::draw_box_outline() and drawing::filled_circle_positions().
GameEngine.h : A highly customizable buy easy to use game engine (or engine for any real-time terminal-based program).
Keyboard.h : A keyboard handling API that is easy to use. Use class StreamKeyboard to poll key presses.
MessageHandler.h : The MessageHandler class allows you to queue up messages of different severity levels and durations. Messages are displayed in a ui::TextBox in the middle of the screen.
ParticleSystem.h : This ASCII-style particle system allows you to make cool real-time VFX such as liquids and fire-smoke. See (SurgSim_Lite and Pilot_Episode for examples).
RC.h : A struct representing the row and column position on the screen or in a texture or bounding box to mention a few.
Rectangle.h : A rectangle struct that can be used for bounding boxes etc.
Screen.h : A collection of functions for rendering dialogs and such:
- Low-level functions: clear_screen(), return_cursor(), restore_cursor(), gotorc().
- draw_frame() : Draws a simple frame around your frame buffer.
- draw_game_over(), draw_you_won() : Draws wavy banners in the FIGlet font Grafitti. Used by GameEngine if those features are enabled.

termin8or's People

Contributors

Stargazers

Watchers

termin8or's Issues

Add class where you can collect ascii-art icons for ease of use in various projects.

Add a dungeon generator

Use a BSP-tree and FBM to modify the wall shapes.

Fix `ASCII_Fonts` function `get_path_to_font_data()`

Fix it so that it works on Windows and also so that it is more generic.

Add support for arrow keys and other special keys on Windows

More flexible font_data data structure?

Add hi-score page support.

Add code for scaling (resampling) the graphics buffer.

Refer to code in my slack boll-plank.

Do not immediately go to the "enter hiscore" screen. Add delay.

I'm not entirely sure what I meant when I wrote this ticket.

Consider renaming the library to something better (preferrably without spaces).

Finish font generation for `smslant`.

Replace adhoc font rendering with the font-rendering engine instead.

In programs such as Pilot Episode and LapSim Lite etc, the text (font) glyphs are typed in by hand, piece by piece. We want to replace this adhoc code with the new ASCII Font rendering system.

Consider moving Delay.h to Core Lib instead as it is not really tied to terminal text stuff.

Hilight current hiscore.

Make game engine more stream-lined.

Among other things, centralize refactor and centralize per top-level Keyboard classes into the Termin8or lib.

Rename Consolation -> Termin8or

Do not show input hiscore screen if your hiscore won't show up in the list.

Add support for extended ASCII chars

I.e use SetConsoleOutputCP(850) on Windows?

Re-reverse the messaging order in `MessageHandler`.

Rename xcode project to match name of repo.

Add quit-confirmation dialog.

Still problems with font loading on Windows

The culprit is utils::sscanf(). It seems like Windows just don't want me to use it.

Use the tokenizer instead.

Add information in `README.md`.

Add support for GUI-design.

Still problems with frame refresh on WSL Ubuntu

Here you can see that:

The terminal is not properly cleared.
The final row gets duplicated below it.

I don't know the reason for the second issue, so therefore it is not so easy to fix, but the first issue can be solved by adding the following code in the init() function of GameEngine:

#ifndef __APPLE__
#ifndef __WIN32
std::system("clear");
#endif
#endif

Add mouse support.

There are three separate solutions for MacOS, Linux and Windows respectively. I have working code for MacOS for starters (from ChatGPT):

#include <iostream>
#include <ApplicationServices/ApplicationServices.h>

using namespace std;

// Global cursor position
int cursor_x = 40;
int cursor_y = 12;

// Callback function to handle mouse events
CGEventRef eventCallback(CGEventTapProxy proxy, CGEventType type, CGEventRef event, void* refcon) {
    if (type == kCGEventMouseMoved || type == kCGEventLeftMouseDragged || type == kCGEventRightMouseDragged) {
        CGPoint location = CGEventGetLocation(event);
        cursor_x = static_cast<int>(location.x);
        cursor_y = static_cast<int>(location.y);

        std::cout << "(x, y) = (" << cursor_x << ", " << cursor_y << ")\n";
    }
    return event;
}

int main() {
    // Create an event tap
    CGEventMask eventMask = (1 << kCGEventMouseMoved) | (1 << kCGEventLeftMouseDragged) | (1 << kCGEventRightMouseDragged);
    CFMachPortRef eventTap = CGEventTapCreate(kCGHIDEventTap, kCGHeadInsertEventTap, 0, eventMask, eventCallback, nullptr);

    if (!eventTap) {
        cerr << "Failed to create event tap" << endl;
        return -1;
    }

    // Create a run loop source and add it to the current run loop
    CFRunLoopSourceRef runLoopSource = CFMachPortCreateRunLoopSource(kCFAllocatorDefault, eventTap, 0);
    CFRunLoopAddSource(CFRunLoopGetCurrent(), runLoopSource, kCFRunLoopCommonModes);

    // Enable the event tap
    CGEventTapEnable(eventTap, true);

    // Run the loop to start receiving events
    CFRunLoopRun();

    // Cleanup
    CFRelease(eventTap);
    CFRelease(runLoopSource);

    return 0;
}

This is built using:

g++ -o mouse_test mouse_test.cpp -framework ApplicationServices

Be able to customize standard screens and dialogs.

Add some other commonly used font.

Migrate git repo to github. Perhaps keeping a local copy as backup, but after migration use the github repo instead of the local one in the xcode project.