Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Desperationis authored Mar 27, 2022
1 parent 41a6802 commit e20cda7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Firstly, [source your ros2 installation](https://docs.ros.org/en/galactic/Tutori

With that, the game should run. Input is taken at the terminal where `ros2 run` was run.

## Configuring
Currently, the following node parameters are implemented:
* `game_fps` - Rate at which the game updates.
* `input_fps` - Rate at which input is processed from the queue.
* `snake_color_*` - Color of the snake in its RGB components.
* `fruit_color_*` - Color of the fruit in its RGB components.
* `grid_color_*` - Color of the grid in its RGB components.

## Limitations / Bugs
1. No launch file is provided (I could make one in the future)
2. Game will crash if you are good enough to fill up the entire board.
Expand Down

0 comments on commit e20cda7

Please sign in to comment.