|
8 | 8 |
|
9 | 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. |
10 | 10 |
|
| 11 | +## Instructions |
| 12 | + |
| 13 | +<details> |
| 14 | +<summary>Install localy</summary> |
11 | 15 |
|
12 | | -### Installation |
13 | 16 | ```bash |
14 | | -#Install node.js libraries |
15 | | -npm install |
| 17 | +git clone https://github.com/michaljaz/web-minecraft |
| 18 | +cd web-minecraft |
| 19 | +yarn install |
| 20 | + |
| 21 | +``` |
| 22 | +</details> |
| 23 | + |
16 | 24 |
|
17 | | -``` |
18 | 25 |
|
19 | | -### Minecraft server setup |
20 | 26 |
|
21 | | -To run this game you need to start real minecraft server (by default it is 1.16.1 offline mode java edition on ip localhost:25565) you can also define it in */src/server.json* file. |
| 27 | +<details> |
| 28 | +<summary>Minecraft server setup</summary> |
| 29 | +To run this game you need to start real minecraft server (by default it is 1.16.1 offline mode java edition on ip localhost:25565) you can also define it in */src/server.json* file. |
22 | 30 |
|
23 | 31 | ```bash |
24 | 32 | #Optionally you can run lite minecraft server (flying-squid) |
25 | | -npm run server |
| 33 | +yarn server |
| 34 | + |
| 35 | +``` |
| 36 | +</details> |
| 37 | + |
| 38 | + |
26 | 39 |
|
27 | | -``` |
28 | 40 |
|
29 | | -### Development setup |
| 41 | +<details> |
| 42 | +<summary>Development setup </summary> |
| 43 | + |
30 | 44 | ```bash |
31 | 45 | #Start node server with webpack middleware |
32 | | -npm run dev |
| 46 | +yarn dev |
33 | 47 |
|
34 | 48 | ``` |
| 49 | +</details> |
| 50 | +<details> |
| 51 | +<summary>Production setup</summary> |
35 | 52 |
|
36 | | -### Production setup |
37 | 53 | ```bash |
38 | 54 | #Cleaning dist folder (old game bundles) |
39 | | -npm run clean |
| 55 | +yarn clean |
40 | 56 |
|
41 | 57 | #Building app bundle |
42 | | -npm run build |
| 58 | +yarn build |
43 | 59 |
|
44 | 60 | #Start node server and serve bundle files |
45 | | -npm start |
| 61 | +yarn start |
46 | 62 |
|
47 | 63 | ``` |
48 | 64 |
|
49 | | -### Screenshots |
50 | | -[<img src="https://i.ibb.co/BLyct2H/Screenshot-from-2021-01-27-21-20-23.png" alt="screen6" width="30%">](https://i.ibb.co/BLyct2H/Screenshot-from-2021-01-27-21-20-23.png) |
51 | | -[<img src="https://i.ibb.co/jzZVrT2/Screenshot-from-2021-01-27-21-13-37.png" alt="screen6" width="30%">](https://i.ibb.co/jzZVrT2/Screenshot-from-2021-01-27-21-13-37.png) |
52 | | -[<img src="https://i.ibb.co/tKmnJ8D/Screenshot-from-2021-01-27-21-16-12.png" alt="screen6" width="30%">](https://i.ibb.co/tKmnJ8D/Screenshot-from-2021-01-27-21-16-12.png) |
| 65 | +</details> |
| 66 | + |
| 67 | +<details> |
| 68 | +<summary>Browser support</summary> |
| 69 | + |
| 70 | +It is prefered to run this game on [Google Chrome](https://www.google.pl/chrome/) (best performance), but it could work on other browsers. |
| 71 | +</details> |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | + |
| 77 | +## Screenshots |
| 78 | +[<img src="https://i.ibb.co/BLyct2H/Screenshot-from-2021-01-27-21-20-23.png" alt="screen6" width="100%">](https://i.ibb.co/BLyct2H/Screenshot-from-2021-01-27-21-20-23.png) |
| 79 | +[<img src="https://i.ibb.co/jzZVrT2/Screenshot-from-2021-01-27-21-13-37.png" alt="screen6" width="100%">](https://i.ibb.co/jzZVrT2/Screenshot-from-2021-01-27-21-13-37.png) |
| 80 | +[<img src="https://i.ibb.co/tKmnJ8D/Screenshot-from-2021-01-27-21-16-12.png" alt="screen6" width="100%">](https://i.ibb.co/tKmnJ8D/Screenshot-from-2021-01-27-21-16-12.png) |
0 commit comments