https://github.com/realstealthninja/texto

A text based renderer ( soon to be game engine )
https://github.com/realstealthninja/texto

3d-graphics ascii ascii-art ascii-graphics cpp cpp-game-engine engine game game-engine image-processing texto video-processing

Last synced: 9 days ago
JSON representation

A text based renderer ( soon to be game engine )

• Host: GitHub
• URL: https://github.com/realstealthninja/texto
• Owner: realstealthninja
• License: mit
• Created: 2023-04-04T14:52:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-21T13:02:24.000Z (3 months ago)
• Last Synced: 2024-10-14T19:20:15.234Z (23 days ago)
• Topics: 3d-graphics, ascii, ascii-art, ascii-graphics, cpp, cpp-game-engine, engine, game, game-engine, image-processing, texto, video-processing
• Language: C++
• Homepage:
• Size: 2.48 MB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


Texto




Your one-stop shop for all things related to ascii.









 Texto is supposed to be an ASCII based renderer.



![License](https://img.shields.io/github/license/realstealthninja/texto?style=flat-square)

![Last commit](https://img.shields.io/github/last-commit/realstealthninja/texto?style=flat-square)

![Repository size](https://img.shields.io/github/repo-size/realstealthninja/texto?style=flat-square)

![build](https://img.shields.io/github/actions/workflow/status/realstealthninja/texto/build-project.yml?style=flat-square&logo=github)

[![Code Scanning](https://github.com/realstealthninja/texto/actions/workflows/codeql.yml/badge.svg)](https://github.com/realstealthninja/texto/actions/workflows/codeql.yml)



Table of contents

=================

* [Installation](#Installation)

* [Usage](#Usage)

* [Contributing](#Want-to-contribute?)

Installation

============

## Gitpod

By using Gitpod, you can skip all the steps which automatically installs all the necessary dependencies and builds the code.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/realstealthninja/texto)

## Locally

1. Clone the Git repository and its submodules.

```bash

git clone --recursive https://github.com/realstealthninja/texto.git

```

2. Install dependencies (Unix/Linux).

```bash

sudo apt-get update && sudo apt-get install ninja-build libopencv-dev

```

> **Note:**

>

> Ninja Build and OpenCV are also available for MacOs and Windows. Check out their binary releases.

> 

> 

3. Build with CMake.

```bash

cmake -DCMAKE_BUILD_TYPE=Release -G Ninja -S ./ -B ./cmake-build-release

cmake --build ./cmake-build-release --target texto -j 1

```

Currently, Texto does not offer a prebuilt package. but it doesn't take a lot to compile.\

You can also run `build.sh`, which runs the exact same commands above.

Usage

=====

```bash

./texto  

```

Want to contribute?

===================

Great!

First off all thank you for even considering contributing.

You can start by reading the Code of Conduct and contributing guidelines (TODO).


Please do raise an issue before opening a pull request discussing on how you are implementing the feature.