https://github.com/alkuzin/fterm
Fallout Terminal library written in C.
https://github.com/alkuzin/fterm
ascii fallout fallout-terminal lib library terminal terminal-app terminal-based
Last synced: about 2 months ago
JSON representation
Fallout Terminal library written in C.
- Host: GitHub
- URL: https://github.com/alkuzin/fterm
- Owner: alkuzin
- License: gpl-3.0
- Created: 2023-10-06T20:59:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-11T08:53:53.000Z (over 2 years ago)
- Last Synced: 2024-11-10T19:13:04.376Z (over 1 year ago)
- Topics: ascii, fallout, fallout-terminal, lib, library, terminal, terminal-app, terminal-based
- Language: C
- Homepage:
- Size: 2.51 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fterm
**Fterm** - Fallout terminal library written in C++23 for Linux.
For other Fallout 4 terminal contents click [here](https://fallout-archive.fandom.com/wiki/Fallout_4_terminals).
## Failed login
## Success login
## Controls
Press **[ TAB ]** key in order to return to the previous options directory.
Press **[ q ]** key to exit.
Press double **[ tab ]** to return to parent options directory from subdirectory.
## Installation
First clone this repository:
```shell
git clone https://github.com/alkuzin/fterm.git
```
Then move to *fterm/* directory and run:
```shell
mkdir -p build
cmake -S . -B build
cmake --build build/ --target fterm_example -j $(nproc)
```
Shared library will be located in `build/libfterm.so`
Be sure that you added `.env` file in the same directory with your executable
for storing password.
```shell
echo "" > .env
```
To run example program execute this command:
```shell
clear && ./build/fterm_example
```
# Documentation
In order to generate project documentation run this command:
```shell
doxygen Doxyfile
```
Documentation will be located in `docs/` directory.
To open it in your browser run:
```shell
open docs/html/index.html
```
## Issues
> [!WARNING]
> If your cursor disappeared run this command:
```shell
printf "\e[?25h"
```