Skip to content

Commit 301d9de

Browse files
Docs: adding games rework (ArchipelagoMW#2892)
* Docs: complete adding games.md rework * remove all the now unused images * review changes * address medic's review * address more comments
1 parent 9dc7089 commit 301d9de

7 files changed

+82
-274
lines changed

docs/adding games.md

+78-269
Large diffs are not rendered by default.

docs/img/creepy-castle-directory.png

-35 KB
Binary file not shown.

docs/img/gato-roboto-directory.png

-79.1 KB
Binary file not shown.
-55.5 KB
Binary file not shown.

docs/img/heavy-bullets-directory.png

-37.6 KB
Binary file not shown.

docs/img/stardew-valley-directory.png

-64.8 KB
Binary file not shown.

docs/options api.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,9 @@ Archipelago will be abbreviated as "AP" from now on.
1010
## Option Definitions
1111
Option parsing in AP is done using different Option classes. For each option you would like to have in your game, you
1212
need to create:
13-
- A new option class with a docstring detailing what the option will do to your user.
14-
- A `display_name` to be displayed on the webhost.
15-
- A new entry in the `option_definitions` dict for your World.
16-
By style and convention, the internal names should be snake_case.
13+
- A new option class, with a docstring detailing what the option does, to be exposed to the user.
14+
- A new entry in the `options_dataclass` definition for your World.
15+
By style and convention, the dataclass attributes should be `snake_case`.
1716

1817
### Option Creation
1918
- If the option supports having multiple sub_options, such as Choice options, these can be defined with
@@ -43,7 +42,7 @@ from Options import Toggle, Range, Choice, PerGameCommonOptions
4342

4443
class StartingSword(Toggle):
4544
"""Adds a sword to your starting inventory."""
46-
display_name = "Start With Sword"
45+
display_name = "Start With Sword" # this is the option name as it's displayed to the user on the webhost and in the spoiler log
4746

4847

4948
class Difficulty(Choice):

0 commit comments

Comments
 (0)