adam/cards
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Adam 2024-08-30 01:51:05 -04:00
parent 07de6177da
commit a34d92b663
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
readme.md
View file

@ -1,5 +1,7 @@
# Cards For Humanity # Cards For Humanity
Live at [https://cards.doordesk.net](https://cards.doordesk.net)
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!") 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. 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.
@ -47,18 +49,17 @@ trunk build --release
### Server ### Server
```sh ```sh
cargo build cargo build --release
``` ```
--- ---
- The server automatically serves the built client from `/dist` at `0.0.0.0:3030` - The server automatically serves the built client from `/dist` at `127.0.0.1:3030`. When building for release the client automatically points to doordesk
- Configure any custom clients to connect to `ws://0.0.0.0:3030/websocket` - Configure any custom clients to connect to `ws://127.0.0.1:3030/websocket` for local testing or `wss://cards.doordesk.net/websocket` to use my server
## TODO: ## TODO:
- finish game logic
- prevent zombie users after browser crash - prevent zombie users after browser crash
- figure out proper auth - client's problem? - figure out proper auth - client's problem?
- use db - use db