Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viandwi24/klasse-io-client
Group Video Call Built in NuxtJS With WebRTC, WebSocket, Peer Connection (Mesh Topology).
https://github.com/viandwi24/klasse-io-client
Last synced: about 1 month ago
JSON representation
Group Video Call Built in NuxtJS With WebRTC, WebSocket, Peer Connection (Mesh Topology).
- Host: GitHub
- URL: https://github.com/viandwi24/klasse-io-client
- Owner: viandwi24
- Created: 2021-07-24T00:21:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-07-31T11:59:22.000Z (over 3 years ago)
- Last Synced: 2023-03-02T18:51:05.509Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 18.6 MB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
# Klasse.io
[](https://img.shields.io/github/issues/viandwi24/klasse-io-client?style=flat-square) 
 [](http://makeapullrequest.com) [](https://GitHub.com/viandwi24/klasse-io-client/graphs/commit-activity) [](https://github.com/viandwi24?tab=followers)
## What is Klasse.io?
A group video call with a mix of rpg games. Make the group atmosphere more interactive.
WebRTC based Video Stream with Peer connection. Then Signaling by WebSocket. With Client Built on NuxtJS as well as NodeJS server.
## Features
#### Video Group Call
Video call build with WebRTC. For now, for handle all client connected we use Peer Connection with Mesh Topology.
For complete documentation you can read in :
- https://webrtc.org
- https://developer.mozilla.org/en-US/docs/Web/API/WebRTC_API
#### Video Call Limitation
We are limited by the radius, players can only communicate within a predetermined radius like a drawn circle. This helps to isolate only players who are near us can communicate with us.
With exceptions, in the future we will create interactive features such as public rooms that will automatically remove this radius. or in a private room which will automatically also make private communication around the marked room.
#### Tile Based Game
Since game maps are tile based, you can design with popular tile base map applications like "Tiled - Tile Map Maker".
Some simple tiles can be used such as the Draw Tile by Layer feature, then add a collision object with a rectangle shape.
You can read complete in :
- Tiled - Tile Map Editor (https://www.mapeditor.org/)
- Example Map : https://github.com/viandwi24/klasse-io-client/blob/master/static/map/demo3/demo3.json
#### Interactive Game
we will soon create interactive features such as interactive boards, or projector screens for share screens, public and private rooms and other features.
#### and other features that will be in the future
You can help in this open source project!
## Build Setup
This client requires a server in the form of Signaling Server and Peer server, you can found in :
- Klasse-io Signaling Server (https://github.com/viandwi24/klasse-io-server)
- Peer Server - (https://www.npmjs.com/package/peer)
```bash
# install dependencies
$ yarn install
# serve with hot reload at localhost:3000
$ yarn dev
# build for production and launch server
$ yarn build
$ yarn nuxt generate
$ yarn start
# generate static project
$ yarn generate
```
## Contributors
## How to contribute
You can follow the contributing guide listed [here](./CONTRIBUTING.md)
## Donate
You can support the development of this project at :
- [Saweria](https://saweria.co/viandwi24)
- [Trakteer](https://trakteer.id/viandwi24)
- [Ko-fi](https://ko-fi.com/viandwi24)
## License
**klasse-io-client** is licensed under the [MIT license](./LICENSE.md).