This commit is contained in:
Oliver Rümpelein 2021-11-07 13:29:06 +01:00
parent dd90929b14
commit a0390d5fca

View file

@ -6,7 +6,7 @@ A simple buzzer implementation using web technologies.
Until artifact storage is provided, start the service using `gradlew run` from within the project directory.
After it succesfully launched, you have access to two clients.
After it successfully launched, you have access to two clients.
### Player-Client
@ -14,7 +14,7 @@ All participants should call `http://<yourHost>:8888/` or `http://<yourHost>:888
Now, they only need to enter their name on top, and they're set.
To trigger the buzzer, they just need to push the large surface. After a short amount of time they will be notified whether they we're the fastest players (button turns green) or not (it turns red).
To trigger the buzzer, they just need to push the large surface. After a short amount of time they will be notified whether they were the fastest players (button turns green) or not (it turns red).
### Game-Master-Client
@ -22,7 +22,7 @@ You can access this client from `http://<yourhost>:8888/clients/master/`.
Your surface consists of three parts. After a game has started, and some player decided they want to do the turn, these have the following functions:
* On top, there's a large surface showing you the fastest player if any.
* Below, you will see the order of players who pushed the button within *500ms* after the fastest player (including the initial push). This information is included solely for transparency reasons and might be used to resolve obvious "Whoops, my beer tipped and I accidentally activated the button!"-like situations to some extent.
* Below, you will see the order of players who pushed the button within *500ms* after the fastest player (including the initial push). This information is included solely for transparency reasons and might be used to resolve obvious "Whoops, my beer tipped, and I accidentally activated the button!"-like situations to some extent.
* A "reset"-button is located at the bottom. Clicking this will prepare the app for the next round. It will forget about all buttons pushed, and re-enable the buttons on the player's clients.
## Troubleshooting & Tips
@ -44,7 +44,7 @@ This project contains a weird mixture of technologies that I wanted to play arou
* Configure startup (IP and port)
* Keep history of previous rounds.
* Ship utility JS libs as asset, don't rely on CDN and internet connectiviy.
* Ship utility JS libs as asset, don't rely on CDN and internet connectivity.
[kotlinxhtml]: https://github.com/Kotlin/kotlinx.html
[alpinejs]: https://alpinejs.dev