You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-1Lines changed: 17 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,22 @@ game. The game engine responds with the Bot ID.
16
16
17
17
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).
18
18
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):
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
+
19
35
## Run locally
20
36
21
37
To run the bot locally, you need to have Go installed on your machine. You can
@@ -31,4 +47,4 @@ make runbotgo
31
47
32
48
- You can start implementing your bot in the `src/bot.go` file.
33
49
- 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