Skip to content

Commit e0c4b7c

Browse files
Add to developer doc page
1 parent 1df3db7 commit e0c4b7c

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

doc/developer.catalog.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Currently supported representations are:
1111
- `.efg` for extensive form games
1212
- `.nfg` for normal form games
1313

14-
Add new games
15-
-------------
14+
Add new game files
15+
------------------
1616

1717
1. **Create the game file:**
1818

@@ -43,3 +43,18 @@ Add new games
4343
.. warning::
4444

4545
Make sure you commit all changed files e.g. run ``git add --all`` before committing and pushing.
46+
47+
Code new games & add game families
48+
----------------------------------
49+
50+
1. **Add the game code:**
51+
52+
Open `catalog/families.py` and create a new function, or modify an existing one. Ensure your function returns a ``Game`` object.
53+
You may wish to vary the game title and/or description based on the chosen parameters.
54+
55+
2. **Update the catalog:**
56+
57+
Update the dictionary returned by ``family_games()`` in `catalog/families.py` with all variants of your game(s) you want in the catalog.
58+
Ensure each entry has unique game slug as key (this will be used by ``pygambit.catalog.load('slug')``), and returns a call of the function with specific parameters.
59+
60+
3. **Submit a pull request to GitHub with all changes.**

0 commit comments

Comments
 (0)