Skip to content

Commit

Permalink
Updated pyproject.toml and README.md to fix pypi errors
Browse files Browse the repository at this point in the history
  • Loading branch information
elliottower committed Feb 4, 2023
1 parent dc34bfb commit 645f44a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ Interactive Multi-Agent Reinforcement Learning Environment for the [Gobblet](htt

Allows for users to play in the same environment, and even play against RL agents trained with [Tianshou](https://github.com/thu-ml/tianshou).

<p align="center">
<img alt="Light" src="./gobblet.jpg" width="45%">
&nbsp; &nbsp; &nbsp; &nbsp;
<img alt="Dark" src="./gobblet_pygame.gif" width="45%">
</p>
<h1 style="text-align: center;width: 80%">
<img alt="Gobblet board game" src="./gobblet.jpg" width="45%">
&nbsp; &nbsp; &nbsp; &nbsp;
<img alt="Gobblet-rl game rendered with Pygame" src="./gobblet_pygame.gif" width="45%">

</h1>

## Installation

Expand Down Expand Up @@ -117,7 +118,7 @@ The default game mode is human vs CPU, with the human playing as red and CPU as

``--render_mode="human" `` will render the game board visually using pygame. Player 1 plays red and goes first, while player 2 plays yellow.

<img src="https://raw.githubusercontent.com/elliottower/gobblet-rl/main/gobblet_pygame.png" width=30% height=30%>
<img alt="Example using render_mode='human'" src="https://raw.githubusercontent.com/elliottower/gobblet-rl/main/gobblet_pygame.png" width=30% height=30%>

When playing interactively, possible moves can be previewed by hovering the mouse over each square. To move a piece which is already placed, simply click on it.

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ authors = [
{ name="Elliot Tower", email="[email protected]" },
]
description = "Multi-Agent Reinforcement Learning Environment for the board game Gobblet using PettingZoo."
readme = "README.md"
requires-python = ">=3.8"
keywords = ["gobblet", "rl", "reinforcement learning", "pettingzoo", "gymnasium", "pygame", "tianshou"]
license = {file = 'LICENSE'}
Expand All @@ -17,11 +18,10 @@ classifiers = [
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
]
dynamic=["version", "readme", "dependencies"]
dynamic=["version", "dependencies"]

[tool.setuptools.dynamic]
version = {attr = "gobblet.__version__"}
readme = {file = ["README.md"]}
dependencies = {file = ["requirements.txt"]}

[project.urls]
Expand Down

0 comments on commit 645f44a

Please sign in to comment.