Skip to content

Commit

Permalink
add configuration details to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
dovixman committed Nov 15, 2024
1 parent d91b595 commit df40614
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,22 @@ game. The game engine responds with the Bot ID.

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).

## Configuration

The needed configuration for the bot is embedded in the command line arguments. You can find the configuration in the [Dockerfile](Dockerfile):
```Dockerfile
CMD [ "./bot", "-bn=pablon-bot", "-la=pablon-bot:3001", "-gs=game:50051" ]
```

The bot is prepared so that you don't need to change anything, but if you want to, you can change the following parameters:
- **Bot port**: The port where the bot will listen for the game engine requests. Defaults to `3001`.

The next parameters are already set for you, and you don't need to change them:
- **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`.
- **Game engine address**: The address where the game engine is listening for the bot requests. Defaults to `game:50051`.



## Run locally

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

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

0 comments on commit df40614

Please sign in to comment.