simponic/chessh
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Elizabeth Hunt 2023-02-24 23:37:52 -07:00 committed by GitHub
parent 31a7303114
commit 859db1bf44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -2,7 +2,7 @@
CheSSH is a distributed multiplayer implementation of the game of Chess over SSH, CheSSH is a distributed multiplayer implementation of the game of Chess over SSH,
written in Elixir, with Discord integrations to deliver alerts when players are written in Elixir, with Discord integrations to deliver alerts when players are
looking for opponents, or in games when it is a player's turn. looking for opponents, or in games when it is one's turn.
https://user-images.githubusercontent.com/25559600/221317658-a80046ca-6009-456d-b43c-67d95baa4bf6.mp4 https://user-images.githubusercontent.com/25559600/221317658-a80046ca-6009-456d-b43c-67d95baa4bf6.mp4
@ -12,8 +12,8 @@ https://user-images.githubusercontent.com/25559600/221317658-a80046ca-6009-456d-
+ `npm` + `npm`
+ `elixir` + `elixir`
+ `postgresql` + `postgresql`
+ `redis` (which you can ignore if you only use the ETS backend for Hammer for + `redis` (which you can ignore if you only use the ETS backend for Hammer in
`config/dev.exs`) `config/dev.exs` [set by default])
### Installation ### Installation
@ -39,6 +39,17 @@ npm install
npm start npm start
``` ```
## Architecture
The process of building the pi cluster is wholly contained in the awful
`buildscripts`, which will individually `ssh` into separate pi's and build the
services locally there as well as update the load balancer pi's configurations for nginx
and HAproxy.
More architecture talk of CheSSH can be found in my (albeit kinda cringe) FSLC
presentation on Elixir:
[https://github.com/Simponic/chessh/blob/main/presentation/chessh.org](https://github.com/Simponic/chessh/blob/main/presentation/chessh.org)
### Environment Variables (mostly optional) ### Environment Variables (mostly optional)
+ `REACT_APP_DISCORD_INVITE` is the invite link to the discord server with the + `REACT_APP_DISCORD_INVITE` is the invite link to the discord server with the
CheSSH bot CheSSH bot
@ -52,13 +63,3 @@ npm start
+ `REMIND_MOVE_CHANNEL_ID` is the channel id to create private threads with players + `REMIND_MOVE_CHANNEL_ID` is the channel id to create private threads with players
for move reminders and other communications for move reminders and other communications
+ `NEW_GAME_CHANNEL_ID` is similar to the above + `NEW_GAME_CHANNEL_ID` is similar to the above
## Architecture
The process of building the pi cluster is wholly contained in the awful
~buildscripts~, which will individually ~ssh~ into separate pi's and build the
services locally as well as update the load balancer pi's configurations for nginx
and HAproxy.
More brief architecture talk of CheSSH can be in my (albeit kinda cringe) FSLC
presentation on Elixir:
[https://github.com/Simponic/chessh/blob/main/presentation/chessh.org](https://github.com/Simponic/chessh/blob/main/presentation/chessh.org)