Skip to content

eric-sims/quipnotes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quipnotes

This project was inspired by a combination of two popular games: "Ransom Notes" by Very Special Games and "Quiplash" by Jackbox Games. Therefore, the combination of these two game names birthed a new name: Quipnotes!

The best way to experience this game is to buy "Ransom Notes" and use the prompt cards located there.

The Problem

My family enjoys playing "Quiplash" at parties because of its ease of use and ability for fun! Later, we started playing "Ransom Notes" which is also loads of fun! However, "Ransom Notes" is not as easy to play because it requires sitting around a table or hard surface. If you don't do this, you'll risk losing the tiny word tiles that are crucial for this game.

Therefore, I started this project! This aims to make "Ransom Notes" as easy to play as any other JackBox-like games.

How to start

Environment Setup

  1. Copy .env.example to .env.
cp .env.example .env
  1. Fill in the actual values in the .env file.

Populate a words.csv file

The "Ransom Notes" games words are proprietary information. Please buy a copy and index those words (this only took me 15 minutes with all the tiles still in sheets). Or, feel free to use whatever word list you would like!

  1. Put the words list in a csv file in one column. No title.
  2. Save it somewhere and update the WORDS_FILE_PATH environment variable in your .env file.

Clients

quipNotes serves a static HTML page that communicates with the server. Please fill in the HTML_DIR_PATH in your .env file. This gives you the option to make your own client or expand upon mine. :)

TODO

  • Finish Client
  • Create a user-friendly interaction for reading the ransom notes (another client?)
  • (Extra) Add a way for users to add custom words to the word list if desired.

About

A lazy version of a popular table-top game.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published