Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkeeter/pont
An online board game in Rust and WebAssembly
https://github.com/mkeeter/pont
board-game game rust wasm webassembly websockets
Last synced: about 1 month ago
JSON representation
An online board game in Rust and WebAssembly
- Host: GitHub
- URL: https://github.com/mkeeter/pont
- Owner: mkeeter
- License: apache-2.0
- Created: 2020-04-08T12:48:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-07T12:32:05.000Z (over 2 years ago)
- Last Synced: 2024-05-15T13:06:57.623Z (4 months ago)
- Topics: board-game, game, rust, wasm, webassembly, websockets
- Language: Rust
- Homepage: https://mattkeeter.com/projects/pont
- Size: 237 KB
- Stars: 259
- Watchers: 8
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# About
### [Project homepage](https://mattkeeter.com/projects/pont)
`pont` is an online game based on
[Qwirkle (by Mindware Games)](https://en.wikipedia.org/wiki/Qwirkle)
Notably, both the client and server are written in Rust;
the only Javascript is a shim to load the WebAssembly module.
# Hosting
It's easiest to run the whole application on a single VM,
using [NGINX](https://www.nginx.com/) to both serve static content
and to act as a secure proxy for websocket communication.
The latter means we don't need SSL support in the game server itself.
The system looks something like this:
I'm hosting a copy of the game at
[https://pont.mattkeeter.com](https://pont.mattkeeter.com),
using a $5/month droplet from [Digital Ocean](https://www.digitalocean.com/)
and [Dreamhost](https://www.dreamhost.com/) for domain registration.
## Initial setup
```
sudo apt update
sudo apt install build-essentials libssl-dev pkg-config
curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
```
## Installing NGINX and setting up Let's Encrypt
```
sudo apt install nginx
sudo apt-get install software-properties-common
sudo add-apt-repository universe
sudo add-apt-repository ppa:certbot/certbot
sudo apt-get update
sudo apt-get install certbot python3-certbot-nginx
sudo certbot --nginx
```
(read and follow `certbot`'s instructions)
## Turn on a firewall to improve security
```
sudo ufw allow ssh
sudo ufw allow http
sudo ufw allow https
sudo ufw allow 8081
sudo ufw enable
```
## Building the client WebAssembly file
```
git clone https://github.com/mkeeter/pont.git
cd pont/pont-client
wasm-pack build --target web
```
## Deploy the nginx config
```
sudo cp pont.conf /etc/nginx/sites-enabled/pont.conf
sudo rm /etc/nginx/sites-enabled/default
sudo nginx -s reload
```
This won't work out of the box, because the configuration assumes the url is
`pont.mattkeeter.com`, which won't be true for you; edit it accordingly.
## Running the server
```
cd pont/pont-server
cargo run --release
```
(leave this in a `screen` session for easy persistence!)
# License
© 2020 [Matthew Keeter](https://mattkeeter.com)
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.