Skip to content

Commit 30deaf8

Browse files
committed
update readme instruction and screenshots
1 parent 371d5e5 commit 30deaf8

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

docs/README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@
66

77
## About
88

9-
**This is Minecraft client written in CoffeeScript.** From web browser this client connects to node.js server and then to real minecraft server, so you can play minecraft in the browser.
9+
**Web-minecraft is minecraft client written in CoffeeScript.** From web browser this client connects to node.js server and then to real minecraft server, so you can play minecraft in the browser.
1010

11-
<i>
12-
</i>
11+
> **_IMPORTANT:_** To run this game you need to start real minecraft server (by default it is 1.16.3 offline mode java edition on ip localhost:25565).
1312
14-
#### Installation
13+
> By default node.js server is served at http://localhost:8080.
14+
15+
### Installation
1516
```bash
1617
#Clone repo
1718
git clone https://github.com/michaljaz/web-minecraft
@@ -21,28 +22,30 @@ cd web-minecraft
2122
npm install
2223

2324
```
24-
#### Development setup
2525

26+
### OPTION 1: Development setup
27+
> **_NOTE:_** Run it if you are developer and want to change code and view realtime changes.
2628
```bash
27-
#Start node server with webpack middleware
29+
#Start node server with webpack middleware (That will start webserver at http://localhost:8080)
2830
npm run dev
2931

3032
```
3133

32-
#### Production setup
34+
### OPTION 2: Production setup
35+
> **_NOTE:_** Run it if you want to only build and serve production app.
3336
```bash
34-
#Cleaning dist folder
37+
#Cleaning dist folder (old game bundles)
3538
npm run clean
3639

3740
#Building app bundle
3841
npm run build
3942

40-
#Start node server and serve bundle files
43+
#Start node server and serve bundle files (That will start webserver ad http://localhost:8080)
4144
npm start
4245

4346
```
4447

45-
#### Screenshots
46-
47-
[<img src="https://i.ibb.co/bgVgNRM/screen7.png" alt="screen6" width="600">](https://i.ibb.co/bgVgNRM/screen7.png)
48-
[<img src="https://i.ibb.co/Snq5b56/screen.png" alt="screen6" width="600">](https://i.ibb.co/Snq5b56/screen.png)
48+
### Screenshots
49+
[<img src="https://i.ibb.co/BLyct2H/Screenshot-from-2021-01-27-21-20-23.png" alt="screen6" width="600">](https://i.ibb.co/BLyct2H/Screenshot-from-2021-01-27-21-20-23.png)
50+
[<img src="https://i.ibb.co/jzZVrT2/Screenshot-from-2021-01-27-21-13-37.png" alt="screen6" width="600">](https://i.ibb.co/jzZVrT2/Screenshot-from-2021-01-27-21-13-37.png)
51+
[<img src="https://i.ibb.co/tKmnJ8D/Screenshot-from-2021-01-27-21-16-12.png" alt="screen6" width="600">](https://i.ibb.co/tKmnJ8D/Screenshot-from-2021-01-27-21-16-12.png)

0 commit comments

Comments
 (0)