Skip to content

Commit 67404c0

Browse files
committed
update README
1 parent b62667f commit 67404c0

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22
A user state page buider for Minecraft.
33

44
# How to use
5-
You can simply build your own web pages, just following this instruction.
5+
You can simply build your own web pages, just follow this instruction.
6+
7+
_You need to do these command in a series._
68

79
## First grab user data from map folder
810
1. Clone the project.
911
2. `npm install`.
1012
3. Rename config.example.yml to config.yml and modify it.
11-
4. Run `npm start`. This will take long time to grab the informations for each user, be patient.
13+
4. Run `npm start`. This will take long time to grab the informations for each user, be patient. Your data will be written to your `output` directory defined in config file.
1214

1315
## Build skin render
1416
1. Go into `skin` folder.
@@ -17,8 +19,33 @@ You can simply build your own web pages, just following this instruction.
1719
## Build web pages
1820
1. Go into `web` folder.
1921
2. `npm install && npm run build`.
22+
2023
## That's all
21-
Now you can find all the files you need in the `web/dist` folder. Upload them to you server, and configure your nginx server like this:
24+
Now you can find all the files you need in the `web/dist` folder.
25+
26+
Move files in place:
27+
28+
* Move `web/dist` to your webroot
29+
* Move the output directory you defined to `webroot/static/data`
30+
31+
### Final File Structures
32+
33+
```
34+
- webroot
35+
+ index.html
36+
- static
37+
+ css
38+
- data # here's the data that main application produces
39+
+ info.json
40+
+ players.json
41+
+ (...) Player UUID directories
42+
+ fonts
43+
+ img
44+
+ js
45+
+ skin
46+
```
47+
48+
Upload webroot to you server, and configure your nginx server like this:
2249

2350
```
2451
server {

0 commit comments

Comments
 (0)