https://github.com/j4james/vtdoom

A port of the DOOM video game for VT sixel terminals.
https://github.com/j4james/vtdoom

doom sixel terminal-game

Last synced: about 1 year ago
JSON representation

A port of the DOOM video game for VT sixel terminals.

• Host: GitHub
• URL: https://github.com/j4james/vtdoom
• Owner: j4james
• License: gpl-2.0
• Created: 2024-09-05T10:29:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-12T19:55:15.000Z (over 1 year ago)
• Last Synced: 2025-01-12T20:28:19.014Z (over 1 year ago)
• Topics: doom, sixel, terminal-game
• Language: C
• Homepage:
• Size: 300 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
VT DOOM

=======

![Screenshot](screenshot.png)

This is a port of the [DOOM] video game for VT terminals supporting the Sixel

graphics protocol. It's mostly playable with standard VT input, but ideally

requires a terminal supporting the win32 input mode used by Windows Terminal.

It was developed with the help of the excellent [PureDOOM] single header port.

[DOOM]: https://en.wikipedia.org/wiki/Doom_(1993_video_game)

[PureDOOM]: https://github.com/Daivuk/PureDOOM

Download

--------

The latest binaries can be found on GitHub at the following url:

https://github.com/j4james/vtdoom/releases/latest

For Linux download `vtdoom`, and for Windows download `vtdoom.exe`.

You'll also need a copy of the `doom1.wad` data file from here:

https://doomwiki.org/wiki/DOOM1.WAD

Build Instructions

------------------

If you want to build this yourself, you'll need [CMake] version 3.15 or later

and a C++ compiler supporting C++20 or later.

1. Download or clone the source:  

   `git clone https://github.com/j4james/vtdoom.git`

2. Change into the build directory:  

   `cd vtdoom/build`

3. Generate the build project:  

   `cmake -D CMAKE_BUILD_TYPE=Release ..`

4. Start the build:  

   `cmake --build . --config Release`

[CMake]: https://cmake.org/

See Also

--------

This project was inspired by [XtermDOOM].

[XtermDOOM]: https://gitlab.com/AutumnMeowMeow/xtermdoom

License

-------

The VT DOOM source code and binaries are released under the GPL-2.0 License.

See the [LICENSE] file for full license details.

[LICENSE]: LICENSE.txt