https://github.com/maxscharwath/toonks-game
TOONKS is a 3D Multiplayer Game where you can play a tiny tank against your friends. You can play on your browser without any installation.
https://github.com/maxscharwath/toonks-game
ammojs enable3d framer-motion game multiplayer react three-react-fiber threejs typescript vitejs webrtc
Last synced: 6 months ago
JSON representation
TOONKS is a 3D Multiplayer Game where you can play a tiny tank against your friends. You can play on your browser without any installation.
- Host: GitHub
- URL: https://github.com/maxscharwath/toonks-game
- Owner: maxscharwath
- License: apache-2.0
- Created: 2022-11-17T00:22:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-25T12:55:52.000Z (over 3 years ago)
- Last Synced: 2024-04-23T18:37:18.622Z (about 2 years ago)
- Topics: ammojs, enable3d, framer-motion, game, multiplayer, react, three-react-fiber, threejs, typescript, vitejs, webrtc
- Language: TypeScript
- Homepage: https://toonks.com
- Size: 96.9 MB
- Stars: 34
- Watchers: 5
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TOONKS đšī¸
> By Nicolas Crausaz, Lazar Pavicevic & Maxime Scharwath
TOONKS is a 3D Multiplayer Game where you can play a tiny tank against your friends.
You can play on your browser without any installation.
## How to play
> Go to https://toonks.com/
## Before playing
For the moment, please play only with Chromium-based browsers (Chrome, Edge, Opera, Brave, Vivaldi, etc.). This game is not compatible with Firefox and Safari.
For the best experience, please use a powerful computer with a good internet connection.
This game use WebRTC to connect players. Your IP can be leaked if you play with a VPN.
We are not responsible for any damage caused by this game. Please play responsibly.
## Technical details
- [x] 3D Game
- [x] Multiplayer
- [x] WebRTC
- [x] React
- [x] Three.js
- [x] TypeScript
- [x] Vite
- [x] TailwindCSS
### Network protocol
The network protocol is based on WebRTC and uses the [PeerJS](https://peerjs.com/) library.
There is a host and multiple clients. The host is the one who creates the game and the clients are the ones who join the game.
## How to run the project
> You need to have Node.js installed on your computer
```bash
# yarn install
# yarn dev
```