Skip to content

Commit df40614

Browse files
author
dovixman
committed
add configuration details to the README
1 parent d91b595 commit df40614

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,22 @@ game. The game engine responds with the Bot ID.
1616

1717
For more in depth information on the game, please refer to the [Game Engine documentation](https://github.com/intelygenz/codeconz-lighthouses-engine/blob/master/README.md).
1818

19+
## Configuration
20+
21+
The needed configuration for the bot is embedded in the command line arguments. You can find the configuration in the [Dockerfile](Dockerfile):
22+
```Dockerfile
23+
CMD [ "./bot", "-bn=pablon-bot", "-la=pablon-bot:3001", "-gs=game:50051" ]
24+
```
25+
26+
The bot is prepared so that you don't need to change anything, but if you want to, you can change the following parameters:
27+
- **Bot port**: The port where the bot will listen for the game engine requests. Defaults to `3001`.
28+
29+
The next parameters are already set for you, and you don't need to change them:
30+
- **Bot name**: Defaults to the name of the owner + the name of the repository. For the template example it will be `intelygenz-codeconz-lighthouses-go-bot`.
31+
- **Game engine address**: The address where the game engine is listening for the bot requests. Defaults to `game:50051`.
32+
33+
34+
1935
## Run locally
2036

2137
To run the bot locally, you need to have Go installed on your machine. You can
@@ -31,4 +47,4 @@ make runbotgo
3147

3248
- You can start implementing your bot in the `src/bot.go` file.
3349
- Do not change anything in the Dockerfile, .github/workflows or protobuf files.
34-
- The bot will not be able to connect to the game engine if it is not running.
50+
- The bot will not be able to connect to the game engine if it is not running.

0 commit comments

Comments
 (0)