Play Uno on the terminal over the internet with your friends, written in Rust!
To play the game, one of the players will need ngrok
installed on their machine. This is the only real dependency required for the game to work.
bash
sudo pacman -S ngrok
bash
ngrok config add-authtoken <token>
The game can be built by cloning this github repo and running cargo build
.
This has to be done by only one player and is a very straightforward procedure. Will take about 5 mins to do.
1. To run the server, first you need to port-forward using ngrok
bash
ngrok tcp <PORT> # eg, port can be 8080
Under Forwarding:
, take note of the url. For example, it could be: tcp://0.tcp.ngrok.io:12345
Then, your join code will be 012345
. Tell this to your friends whom you are playing with. You yourself will need it as well.
2. Then, you need to run the runo server. This can be done by doing...
bash
cargo r -- -s -p <PORT> # You do not need to specify port, it chooses 8080 by default. Just make sure the port matches with the one in ngrok.
This has to be done by all the players (including the person who runs the server).
bash
cargo r -- -c -j <JOIN CODE>
Hence, one person has to:
1. Run ngrok. eg: ngrok tcp 8080
-> Forwarding: tcp://0.tcp.ngrok.io:12345
-> Join Code is '012345'
2. Run the Runo server. cargo r -- -s
3. Run the client cargo r -- -c -j "012345
(This has to be done by everyone who want to play Uno).
Once all clients have connected, the person who's running the server can type start
on the server terminal to start the game!
If you encounter any bugs or have ideas for new features, I encourage you to submit them via GitHub issues. Your feedback is valuable and will help me improve the project.
See LICENSE for details.