fantasy-console/README.md

25 lines
744 B
Markdown
Raw Permalink Normal View History

2023-05-14 23:39:22 -07:00
# Faux
2023-05-06 17:18:49 -07:00
2025-02-19 20:04:40 -08:00
This is a custom fantasy-console (like Pico 8) written in Deno/Typescript.
2023-05-14 23:39:22 -07:00
Go to the [Releases](https://git.playbox.link/dylan/fantasy-console/releases) page to find downloadable executables.
NOTE: If you are running Faux on Linux, you will need to have `xsel` installed.
## Developing
2023-05-14 23:41:46 -07:00
Faux is written in [TypeScript](https://www.typescriptlang.org/) to be run or compiled by [Deno](https://deno.com/runtime).
2023-05-14 23:39:22 -07:00
If you want to build from source, you should have Deno installed, clone this repo, and then...
To run:
2023-05-06 17:18:49 -07:00
```
deno task run
```
2023-05-14 23:39:22 -07:00
To compile:
2023-05-06 17:18:49 -07:00
```
2023-05-14 23:39:22 -07:00
deno task build_all
2023-05-14 23:41:46 -07:00
```
NOTE: Development is happening solely on Linux, so some build commands may fail if you are not on Linux or do not have some build dependencies installed.