mirror of
https://github.com/PrismarineJS/prismarine-web-client.git
synced 2025-02-26 22:23:53 -05:00
37 lines
1.2 KiB
Markdown
37 lines
1.2 KiB
Markdown
# prismarine-web-client
|
|
[](http://npmjs.com/package/prismarine-web-client)
|
|
[](https://github.com/PrismarineJS/prismarine-web-client/actions?query=workflow%3A%22CI%22)
|
|
[](https://discord.gg/GsEFRM8)
|
|
[](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-web-client)
|
|
|
|
A minecraft client running in a web page. Demo at https://prismarine-web-client.js.org
|
|
|
|
It runs mineflayer in the browser which connects to a websocket minecraft server.
|
|
It provides a simple websocket to tcp proxy as a backend to make it possible to connect to any minecraft server.
|
|
|
|
## Usage
|
|
|
|
`npm install -g prismarine-web-client` then run `prismarine-web-client` then open `http://localhost:8080` in your browser
|
|
|
|
## Features
|
|
|
|
* display blocks
|
|
* display entities as colored rectangles
|
|
* movement sync
|
|
|
|
## Roadmap
|
|
|
|
* chat
|
|
* block placing and breaking
|
|
|
|
## Development
|
|
|
|
```js
|
|
npm install
|
|
npm run build-start
|
|
```
|
|
|
|
Then connect to http://localhost:8080
|
|
|
|
|
|
|