Skip to content

Commit 7c09897

Browse files
authored
clean up readme (#45)
* clean up readme * more cleaning up * add word * am stupid * change project name * fix typos * move live demo * Update README.md * be less specific
1 parent 2140ed3 commit 7c09897

File tree

1 file changed

+46
-16
lines changed

1 file changed

+46
-16
lines changed

README.md

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,67 @@
44
[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](https://discord.gg/GsEFRM8)
55
[![Try it on gitpod](https://img.shields.io/badge/try-on%20gitpod-brightgreen.svg)](https://gitpod.io/#https://github.com/PrismarineJS/prismarine-web-client)
66

7-
A minecraft client running in a web page. Demo at https://prismarine-web-client.js.org
7+
### A Minecraft client running in a web page. **Live demo at https://prismarine-web-client.js.org**
88

9-
It runs mineflayer in the browser which connects to a websocket minecraft server.
10-
It provides a simple websocket to tcp proxy as a backend to make it possible to connect to any minecraft server.
9+
10+
11+
## How it Works
12+
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.
1113

1214
## Screenshot
13-
![Screenshot of MineWeb in action](screenshot.png)
15+
![Screenshot of prismarine-web-client in action](screenshot.png)
16+
17+
## Live Demo
18+
Click on this link to open it in your browser, no installation necessary: https://prismarine-web-client.js.org
1419

15-
## Usage
20+
*Tested on Chrome & Firefox for desktop platforms.*
1621

17-
`npm install -g prismarine-web-client` then run `prismarine-web-client` then open `http://localhost:8080` in your browser
22+
## Usage (for self-hosted installations)
23+
If you want the latest version or want to use auth, you can host an instance yourself.
24+
25+
Run these commands in bash:
26+
```bash
27+
$ npm install -g prismarine-web-client
28+
$ prismarine-web-client
29+
```
30+
Finally, open `http://localhost:8080` in your browser.
1831

1932
## Features
2033

21-
* display blocks
22-
* display entities as colored rectangles
23-
* movement sync
34+
* Display mobs (though sometimes messed up)
35+
* Display players
36+
* Display other entities as colored rectangles
37+
* Display blocks
38+
* Movement (you can move, and you see entities moving live)
39+
* Place and break blocks
2440

2541
## Roadmap
26-
27-
* chat
28-
* block placing and breaking
42+
* Containers (inventory, chests, etc.)
43+
* More Customisation (e.g. mouse sensitivity, text size, issue #40)
44+
* Sounds
45+
* More World Interactions (attacking entities, etc.)
46+
* Cosmetic Rendering Features (day night cycle, fog, etc.)
47+
* Server-Side Support Plugins (for auth bypass & possibly hosting its own websocket proxy to reduce latency, issue #13)
2948

3049
## Development
3150

32-
```js
33-
npm install
34-
npm run build-start
51+
If you're contributing/making changes, you need to install it differently.
52+
53+
First, clone the repo.
54+
55+
Then, set your working directory to that of the repo. For example:
56+
```bash
57+
$ cd ~/prismarine-viewer/
58+
```
59+
60+
Finally, run
61+
62+
```bash
63+
$ npm install
64+
$ npm run build-start
3565
```
3666

37-
Then connect to http://localhost:8080
67+
Then connect to http://localhost:8080 in your browser.
3868

3969

4070

0 commit comments

Comments
 (0)