Voxum is a proximity voice chatting application for Minecraft Bedrock Edition. This plugin allows you to enhance your gameplay!
Warning: This project is not done and doesn't work yet! Wait until further notice!
While playing Among Us with a few friends I discovered a very cool program called "CrewLink". It's a very cool way to add proximity voice chatting in Among Us. I liked the idea so much that I wanted to make an equivalent program, but for Minecraft Bedrock Edition.
I'm a full-time student so I actually don't have a lot of time to work on this, so when I have time I work on the things that seem the most fun at the moment. So don't expect too much from this project =). I'm just trying having fun on this journey and create something cool on the way.
- StackOverflow <3
- LaraCasts
- ...
Voxum has been built on some awesome existing software:
- Laravel framework
- Laravel Breeze for authentication
- Laravel Echo for integration with Laravel Websockets
- Laravel WebSockets for the communication between the backend and the frontend
- Redis Pub/Sub to transfer the data from the Minecraft Server to the Laravel server
- PeerJS simple wrapper for WebRTC
- Golileo for saving player skins in a centralized system
Voxum consists of a few parts:
| Name | Description | Link |
|---|---|---|
| Voxum Client | The webclient that is used to voice chat with others. It's a bit like Discord where you join a channel and can talk to other people in your proximity. | https://github.com/Mohagames205/voxum-rewritten |
| Voxum plugin | The plugin allows communication between the Minecraft server and the Voxum Client. It sends all necessary data to the client | https://github.com/Mohagames205/voxum |
| Voxum Toolkit | This is a toolkit maintainers can use to easily test all features of Voxum | https://github.com/Mohagames205/voxum-toolkit |
Warning: the webapp is NOT YET FUNCTIONAL! An easier method to deploy this will be made soon!!
- A Redis server
- PHP >=8.0
- NodeJS 18
- PeerJS server 0.6.1
You can try this non-functional demo by cloning this repository:
git clone https://github.com/Mohagames205/voxum-rewritten.git
Install all dependencies
composer install
npm install
npm install peer -g
Note
If you're on Windows you can simply use.\devstart.cmdto start up all the services.
Start Vite to enable on the fly asset compilation
npm run dev
Start the WebSocket server
php artisan websocket:serve
Start the Redis subscription service
php artisan redis:subscribe
Start the PeerJS server on port 3000
peerjs --port=3000
Serve the application using the included development webserver
php artisan serve
There are a few things I want to achieve (sorted from high to low priority):
- Making proximity voice chatting functional
- A verification system for Minecraft players so they don't have to authenticate with Xbox-live
- Create an administration panel to manage the Voxum instance
- Create a toolkit to make testing Voxum easier
- In-game indicator for if the player is using Voxum
- Making clear documentation
The Voxum instance has not been set-up yet
Set-up page for a new instance
