2021-02-27 22:12:11 +00:00
# prismarine-web-client
[](http://npmjs.com/package/prismarine-web-client)
[](https://github.com/PrismarineJS/prismarine-web-client/actions?query=workflow%3A%22CI%22)
2021-02-27 22:27:59 +01:00
[](https://discord.gg/GsEFRM8)
2021-02-27 22:12:11 +00:00
[](https://gitpod.io/#https://github .com/PrismarineJS/prismarine-web-client)
2021-02-27 22:27:59 +01:00
2021-03-02 15:25:43 -05:00
### A Minecraft client running in a web page. **Live demo at https://prismarine-web-client.js.org**
2021-02-27 22:27:59 +01:00
2021-03-02 15:25:43 -05:00
## How it Works
prismarine-web-client runs mineflayer and prismarine-viewer in the browser, which connects over WebSocket to a proxy which translates the WebSocket connection into TCP to connect to normal Minecraft servers.
2021-02-27 22:27:59 +01:00
2021-02-28 21:45:27 -05:00
## Screenshot
2021-03-02 15:25:43 -05:00
## Live Demo
Click on this link to open it in your browser, no installation necessary: https://prismarine-web-client.js.org
2021-02-28 21:45:27 -05:00
2021-03-02 15:25:43 -05:00
*Tested on Chrome & Firefox for desktop platforms.*
2021-02-27 22:35:59 +00:00
2021-03-02 15:25:43 -05:00
## Usage (for self-hosted installations)
If you want the latest version or want to use auth, you can host an instance yourself.
Run these commands in bash:
```bash
$ npm install -g prismarine-web-client
$ prismarine-web-client
```
Finally, open `http://localhost:8080` in your browser.
2021-02-27 22:35:59 +00:00
2021-02-27 22:12:11 +00:00
## Features
2021-03-02 15:25:43 -05:00
* Display mobs (though sometimes messed up)
* Display players
* Display other entities as colored rectangles
* Display blocks
* Movement (you can move, and you see entities moving live)
* Place and break blocks
2021-02-27 22:12:11 +00:00
## Roadmap
2021-03-02 15:25:43 -05:00
* Containers (inventory, chests, etc.)
* More Customisation (e.g. mouse sensitivity, text size, issue #40 )
* Sounds
* More World Interactions (attacking entities, etc.)
* Cosmetic Rendering Features (day night cycle, fog, etc.)
* Server-Side Support Plugins (for auth bypass & possibly hosting its own websocket proxy to reduce latency, issue #13 )
2021-02-27 22:27:59 +01:00
2021-02-27 22:35:59 +00:00
## Development
2021-02-27 22:12:11 +00:00
2021-03-02 15:25:43 -05:00
If you're contributing/making changes, you need to install it differently.
First, clone the repo.
Then, set your working directory to that of the repo. For example:
```bash
$ cd ~/prismarine-viewer/
```
Finally, run
```bash
$ npm install
$ npm run build-start
2021-02-27 22:27:59 +01:00
```
2021-03-02 15:25:43 -05:00
Then connect to http://localhost:8080 in your browser.
2021-02-27 22:12:11 +00:00
2021-02-27 22:27:59 +01:00
