https://github.com/lorencerri/play-doom

An API to fetch video frames of Doom based on a given input
https://github.com/lorencerri/play-doom

Last synced: 18 days ago
JSON representation

An API to fetch video frames of Doom based on a given input

• Host: GitHub
• URL: https://github.com/lorencerri/play-doom
• Owner: lorencerri
• Created: 2022-06-02T20:53:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-06T14:58:32.000Z (6 months ago)
• Last Synced: 2024-10-03T16:15:17.881Z (about 1 month ago)
• Language: TypeScript
• Homepage:
• Size: 4.26 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
**Play Doom!**

![](https://doom-api.plexidev.org/frame/github/?type=.gif)


### Controls (rewind)

- Idle Frame [10x] [25x] [50x]

- Escape (Open/Close Menu)

- Enter

- Arrow [Left (5x) (25x)] [Right (5x) (25x)] [Up (5x) (25x)] [Down (5x) (25x)]

- Alt

- Shift

- Space (Use)

- CTRL (Shoot) [Spam Button]

- Tab (Map)

- Shift + [Up Arrow] [Down Arrow] [Left Arrow] [Right Arrow]

- Strafe [Left] [Right]

- Yes

- No

- Item Slot [2] [3] [4] [5] [6] [7]

### Meta Actions

- Reset Game

### Videos

- Get full video of current run

- Get full video of all previous runs combined

- Get full video of all previous runs combined + current run

**## END_GAME ##**

## play-doom

An API wrapper for [@lorencerri/doomreplay](https://github.com/lorencerri/doomreplay), enter the submodule for more information.

**Statistics**



**Endpoints**

```sh

GET /stats?image=true # Returns the global stats

GET /video/:namespace/current # Returns a video of the full current run

GET /video/:namespace/full # Returns a video of all the previous runs combined

GET /video/:namespace/combined # Returns a video of all the previous runs combined, plus the current run

GET /frame/:namespace?type=gif # Returns the current frame

GET /input/:namespace?image=true # Returns an image or text

GET /input/:namespace/reset?callback="" # Resets the input buffer

GET /input/:namespace/append?keys=""&callback="" # Appends keys to the input buffer

GET /input/:namespace/rewind?amount=1&callback="" # Rewinds the input buffer by N keys

```

**Notes**

- Use `git clone --recursive https://github.com/lorencerri/play-doom.git` to clone play-doom & doomreplay

- Use [vscode-drawio](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) to open `play-doom.drawio` in vscode