Skip to content

Commit 7c80888

Browse files
committed
Change readme
1 parent 18c0e04 commit 7c80888

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

.env_example

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
LISTEN_PORT=4001
2-
ADMIN_PASSWORD=
2+
ADMIN_PASSWORD=
3+
WEB_CLIENT=

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,25 @@
22

33
This project was part of [minecraftLegion](https://github.com/sefirosweb/minecraftLegion).
44

5-
This is a backend for manage the bot.
5+
This is a bridge for manage the bot.
66

77
## Install:
88
- Install [Node.js](https://nodejs.dev/) version 14+
99
- go to the directory which you want to install into
1010
- run `npm i minecraftLegionWebServer` on command prompt
11-
- make a new file called config.js with the fields shown below
11+
- make a new file called .env with the fields shown below
12+
```env
13+
LISTEN_PORT=4001
14+
ADMIN_PASSWORD=AdminnPassForManageBot
15+
WEB_CLIENT=http://localhost:4000
16+
```
17+
- Run the app with `npm start`
18+
- WEB_CLIENT => Is minecraftLegionWebClient host:port, is used for accept CORS
1219

1320
## Usage:
14-
15-
### `npm start`
16-
17-
Runs the app.
18-
19-
The bot is liten on port 4001 for connect bots and frontend
20-
21+
Start app with `npm start`
22+
They start listening with port you selected in .env file
23+
No need anything else, this app is used for bridge / middleware between bots and front end
2124

2225
# TODO
23-
- Make a Configuration flexible
2426
- Make a robuts documentation

docs/history.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# 0.1.6
22
* Change version directly same has minecraftLegion for have "sync" versions
3+
* Added dynamic call for configure bot
34

45
## 0.0.3
56
* Added security on websocket with password (see .env_example)

0 commit comments

Comments
 (0)