prismarine-web-client-mirror/README.md

34 lines
1 KiB
Markdown
Raw Normal View History

2021-02-27 17:12:11 -05:00
# prismarine-web-client
[![NPM version](https://img.shields.io/npm/v/prismarine-web-client.svg)](http://npmjs.com/package/prismarine-web-client)
[![Build Status](https://github.com/PrismarineJS/prismarine-web-client/workflows/CI/badge.svg)](https://github.com/PrismarineJS/prismarine-web-client/actions?query=workflow%3A%22CI%22)
2021-02-27 16:27:59 -05:00
[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)
2021-02-27 17:12:11 -05:00
[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-web-client)
2021-02-27 16:27:59 -05:00
2021-02-27 17:12:11 -05:00
A minecraft client running in a web page.
2021-02-27 16:27:59 -05:00
2021-02-27 17:12:11 -05:00
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.
2021-02-27 16:27:59 -05:00
2021-02-27 17:12:11 -05:00
## Features
* display blocks
* display entities as colored rectangles
* movement sync
## Roadmap
* chat
* block placing and breaking
2021-02-27 16:27:59 -05:00
2021-02-27 17:12:11 -05:00
## Run
```js
npm install
npm run build-start
2021-02-27 16:27:59 -05:00
```
2021-02-27 17:12:11 -05:00
Then connect to http://localhost:8080
2021-02-27 16:27:59 -05:00