cards/readme.md
2024-07-18 19:53:28 -04:00

29 lines
1.2 KiB
Markdown

# Cards For Humanity
A game master server for the popular game [Cards Against Humanity](https://www.cardsagainsthumanity.com/) using data from [Chris Hallberg](https://crhallberg.com/)'s project [JSON Against Humanity](https://github.com/crhallberg/json-against-humanity) (everyone say "Thanks, Chris!")
This started as a problem trying to play games with friends who are all on different platforms. This shall be as cross-platform as it gets. I want it to work on anything that can establish a connection and allow anyone to write any front-end they can dream up whether it be a web page, chat bot, VR, etc. Any clients who share a master server can play together across any platform.
## Dev stuff:
### Client
* [Install Trunk](https://trunkrs.dev/#install)
* `trunk build` or `trunk serve --open` (hot reload on port 8080) from `client` dir to build test client
### Server
* `cargo run` to run server
open `localhost:3030` in your browser to run test client or connect to `ws://localhost:3030/websocket` with a custom client
## TODO:
* figure out auth
* finish game logic
* support card text editing
* prevent import of cards that have been seen already and edited
* handle duplicates
* use db
* efficiency
* make demo clients for multiple platforms and screens