prismarine-web-client-mirror/README.md

# 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)
[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)
[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](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.

## Screenshot
![Screenshot of MineWeb in action](screenshot.png)

## 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
add code 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)`
Initial commit 2021-02-27 16:27:59 -05:00			`[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)`
add code 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)`
Initial commit 2021-02-27 16:27:59 -05:00
Add demo link 2021-02-28 21:16:10 -05:00			`A minecraft client running in a web page. Demo at https://prismarine-web-client.js.org`
Initial commit 2021-02-27 16:27:59 -05:00
add code 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.`
Initial commit 2021-02-27 16:27:59 -05:00
add screenshot to readme (#19) * add screenshot to readme * move screenshot into the repo 2021-02-28 21:45:27 -05:00			`## Screenshot`
			`![Screenshot of MineWeb in action](screenshot.png)`

fix server import 2021-02-27 17:35:59 -05:00			`## Usage`

			`npm install -g prismarine-web-client` then run `prismarine-web-client` then open `http://localhost:8080` in your browser

add code 2021-02-27 17:12:11 -05:00			`## Features`

			`* display blocks`
			`* display entities as colored rectangles`
			`* movement sync`

			`## Roadmap`

			`* chat`
			`* block placing and breaking`
Initial commit 2021-02-27 16:27:59 -05:00
fix server import 2021-02-27 17:35:59 -05:00			`## Development`
add code 2021-02-27 17:12:11 -05:00
			```js
			`npm install`
			`npm run build-start`
Initial commit 2021-02-27 16:27:59 -05:00			```

add code 2021-02-27 17:12:11 -05:00			`Then connect to http://localhost:8080`

Initial commit 2021-02-27 16:27:59 -05:00