diff --git a/README.md b/README.md index baf8913..bd33ddd 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,12 @@ the [Euskal Encounter](https://ee32.euskalencounter.org/) in Bilbao, Spain. We are proud to present the "Reloaded" version of the contest, which features a new engine from scratch written in Go and a proper GRPC API for the engine to communicate with the bots. -You can find the Game mechanics and rules at our [Game Documentation](https://coda.io/@gabri-igz/lighthouses). +- [Game Instructions](https://coda.io/@gabri-igz/lighthouses). +- [Game Engine Documentation](docs/game_engine.md) +- [Game Visualizer](https://intelygenz.github.io/codeconz-lighthouses-engine/) +- [Map Generator](https://dovixman.github.io/lighthouses_map_generator/) +- [Go bot template](https://github.com/new?owner=intelygenz&template_name=codeconz-lighthouses-go-bot&template_owner=intelygenz) +- [Python random bot template](https://github.com/new?owner=intelygenz&template_name=codeconz-lighthouses-py-bot&template_owner=intelygenz) To start building a bot, you will need to take the following steps: @@ -73,7 +78,7 @@ You can also run `./start-game.sh -h` to see the available options. ### Visualizing and diagnosing a game -To visualize and analyze the game, you can upload a JSON file from the `/output` folder to the [Lighthouses Game Visualizer](https://intelygenz.github.io/codeconz-lighthouses-engine/). +To visualize and analyze the game, you can upload a JSON file from the `/output` folder to the [Game Visualizer](https://intelygenz.github.io/codeconz-lighthouses-engine/). This tool will help you check what your bot did during the game and how it performed. ### Customizing the game @@ -108,7 +113,7 @@ You are expected to create your own maps to test your bot under different scenar To do so: -- use the [Lighthouses Map Generator](https://dovixman.github.io/lighthouses_map_generator/) to generate a new map +- use the [Map Generator](https://dovixman.github.io/lighthouses_map_generator/) to generate a new map - copy the generated map to the `/maps` folder in the engine repository - update the `game.cfg` file to use the new map: `map={map_name}.txt`