Skip to content

Commit 73a21e2

Browse files
committed
add url params info in docs
1 parent 59175f3 commit 73a21e2

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

docs/DEVELOPMENT.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,31 @@ Connect to http://localhost:8080 in your browser. Also specify correct server ip
2626
npm run build
2727
```
2828

29-
After calling this, it will build app bundle with minified code (in ```/src/dist/``` directory). It may take longer than development setup. By default webmc connects to https://webmcproxy.glitch.me.
29+
After calling this, it will build app bundle with minified code (in ```/src/dist/``` directory). It may take longer than development setup.
3030

3131
Then you have to host built files on some simple http server like [http-server](https://www.npmjs.com/package/http-server).
3232

33-
You can also setup your own proxy server. First of all install only production depencies by running ```npm install --only=production```. Then, all you have to do is to run ```npm run proxy``` on server and change some configs in ```/src/assets/config.json```.
33+
## How works webmc url params?
34+
35+
### ?nick=
36+
37+
Minecraft user nickname
38+
39+
### ?server=
40+
41+
It is just server ip like "serverip.eu" or "serverip.eu:25565"
42+
43+
### ?proxy=
44+
45+
Here are webmc proxy options in ?proxy=[string] url param:
46+
47+
- ```production``` default production option, server: https://webmcproxy.glitch.me
48+
- ```local``` default local-dev option, server: localhost
49+
- ```[server_hostname]:[port]``` custom proxy server (sometimes ssl certs might not work)
50+
51+
## Own proxy server
52+
53+
You can also setup your own proxy server. It is just translates Websocket connection to TCP connection. You don't need to install all the depencies, just the ones you need. First of all install only production depencies by running ```npm install --only=production```. Then, all you have to do is to run ```npm run proxy``` on server and change some configs in ```/src/assets/config.json```. Sometimes it is also useful to swap the "proxy" script with "start" in package.json (your app will run proxy by default).
3454

3555
## Download production files
3656

0 commit comments

Comments
 (0)