Skip to content

Commit 515258e

Browse files
committed
npm convert to yarn & collapse instructions
1 parent ab4e3d8 commit 515258e

File tree

5 files changed

+6823
-24
lines changed

5 files changed

+6823
-24
lines changed

.npmrc

Lines changed: 0 additions & 2 deletions
This file was deleted.

README.md

Lines changed: 46 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,45 +8,73 @@
88

99
**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+
## Instructions
12+
13+
<details>
14+
<summary>Install localy</summary>
1115

12-
### Installation
1316
```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+
1624

17-
```
1825

19-
### Minecraft server setup
2026

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.
2230

2331
```bash
2432
#Optionally you can run lite minecraft server (flying-squid)
25-
npm run server
33+
yarn server
34+
35+
```
36+
</details>
37+
38+
2639

27-
```
2840

29-
### Development setup
41+
<details>
42+
<summary>Development setup </summary>
43+
3044
```bash
3145
#Start node server with webpack middleware
32-
npm run dev
46+
yarn dev
3347

3448
```
49+
</details>
50+
<details>
51+
<summary>Production setup</summary>
3552

36-
### Production setup
3753
```bash
3854
#Cleaning dist folder (old game bundles)
39-
npm run clean
55+
yarn clean
4056

4157
#Building app bundle
42-
npm run build
58+
yarn build
4359

4460
#Start node server and serve bundle files
45-
npm start
61+
yarn start
4662

4763
```
4864

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)

package.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,5 @@
5656
"webpack": "^5.9.0",
5757
"webpack-cli": "^4.2.0",
5858
"webpack-node-externals": "^2.5.2"
59-
},
60-
"engines": {
61-
"node": ">=14"
6259
}
6360
}

src/server.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"ip":"localhost",
33
"port":25565,
4-
"version":"1.16.1"
4+
"version":"1.16.5"
55
}

0 commit comments

Comments
 (0)