Twitch/Chatman
0
0
Fork 0
Code Issues Activity
An API that allows Twitch to play Hangman in chat.
61 commits 2 branches 0 tags 125 KiB
Find a file
Oliver-Akins 9db47a36c4 Remove log
2023-08-26 20:46:17 -06:00
docs/nightbot Add the solve subcommand to the docs 2023-02-20 20:21:50 -07:00
scripts Add a helper script in order to clean a CSV file into a compatible format 2023-08-26 20:39:10 -06:00
site Gitkeep the site directory 2023-02-19 20:51:49 -07:00
src Remove log 2023-08-26 20:46:17 -06:00
.gitignore Add the words directory to the gitignore 2023-01-07 18:05:17 -06:00
config.template.toml Update default config file 2023-01-20 00:01:33 -06:00
docker-compose.yaml Fix the target and environment 2023-08-26 20:45:52 -06:00
dockerfile Fix the target and environment 2023-08-26 20:45:52 -06:00
generateInterfaces.ts Initial commit 2022-12-23 15:19:37 -06:00
package.json Add socket.io as a dependency 2023-02-19 12:10:53 -07:00
pnpm-lock.yaml Add socket.io as a dependency 2023-02-19 12:10:53 -07:00
README.md Add a bit about the overlay themes into the README 2023-02-19 20:53:30 -07:00
tsconfig.json Add the neccesary docker files for operation 2023-08-26 20:42:22 -06:00

README.md

Chatman

A REST API that can be used to play Hangman with predefined words.

Originally developed to play Hangman in CzechGamesEdition's Twitch Channel using the custom Codenames deck created by chat submissions.

Setup

Overlay Themes

Clone any Chatman overlay themes you'd like into the site directory, this is where all of the files are served from.

Development

  1. pnpm install (install pnpm if it isn't installed already)
  2. cp config.template.toml config.toml
  3. make interfaces (re-run whenever you change a schema in src/schemas/*)
  4. make dev (compiles and runs the code in dev mode) or make rund (skips the compile step, runs it in dev mode)

Production

  1. Same steps as Development, but use make run to run the API in production mode. You may need to change the NODE argument in the makefile to make it run correctly.