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
agilbert1412 · Mar 29, 2024 · 301d9de · 301d9de
1 parent 9dc7089
commit 301d9de
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 274 deletions.
diff --git a/docs/adding games.md b/docs/adding games.md
diff --git a/docs/img/creepy-castle-directory.png b/docs/img/creepy-castle-directory.png
diff --git a/docs/img/gato-roboto-directory.png b/docs/img/gato-roboto-directory.png
diff --git a/docs/img/heavy-bullets-data-directory.png b/docs/img/heavy-bullets-data-directory.png
diff --git a/docs/img/heavy-bullets-directory.png b/docs/img/heavy-bullets-directory.png
diff --git a/docs/img/stardew-valley-directory.png b/docs/img/stardew-valley-directory.png
diff --git a/docs/options api.md b/docs/options api.md
@@ -10,10 +10,9 @@ Archipelago will be abbreviated as "AP" from now on.
 ## Option Definitions
 Option parsing in AP is done using different Option classes. For each option you would like to have in your game, you
 need to create:
-- A new option class with a docstring detailing what the option will do to your user.
-- A `display_name` to be displayed on the webhost.
-- A new entry in the `option_definitions` dict for your World.
-By style and convention, the internal names should be snake_case.
+- A new option class, with a docstring detailing what the option does, to be exposed to the user.
+- A new entry in the `options_dataclass` definition for your World.
+By style and convention, the dataclass attributes should be `snake_case`.
 
 ### Option Creation
 - 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
 
 class StartingSword(Toggle):
     """Adds a sword to your starting inventory."""
-    display_name = "Start With Sword"
+    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
 
 
 class Difficulty(Choice):