mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 12:11:33 -06:00
Docs: Update to adding games.md (#4816)
This commit is contained in:

committed by
GitHub

parent
1fd8e4435e
commit
934b09238e
@@ -60,7 +60,7 @@ These are "nice to have" features for a client, but they are not strictly requir
|
||||
if possible.
|
||||
|
||||
* If your client appears in the Archipelago Launcher, you may define an icon for it that differentiates it from
|
||||
other clients. The icon size is 38x38 pixels, but it will accept larger images with downscaling.
|
||||
other clients. The icon size is 48x48 pixels, but smaller or larger images will scale to that size.
|
||||
|
||||
## World
|
||||
|
||||
@@ -109,6 +109,10 @@ subclass for webhost documentation and behaviors
|
||||
* A non-zero number of locations, added to your regions
|
||||
* A non-zero number of items **equal** to the number of locations, added to the multiworld itempool
|
||||
* In rare cases, there may be 0-location-0-item games, but this is extremely atypical.
|
||||
* A set
|
||||
[completion condition](https://github.com/ArchipelagoMW/Archipelago/blob/main/BaseClasses.py#L77) (aka "goal") for
|
||||
the player.
|
||||
* Use your player as the index (`multiworld.completion_condition[player]`) for your world's completion goal.
|
||||
|
||||
### Encouraged Features
|
||||
|
||||
@@ -145,8 +149,8 @@ workarounds or preferred methods which should be used instead:
|
||||
* It is discouraged to use `yaml.load` directly due to security concerns.
|
||||
* When possible, use `Utils.yaml_load` instead, as this defaults to the safe loader.
|
||||
* When submitting regions or items to the multiworld (`multiworld.regions` and `multiworld.itempool` respectively),
|
||||
Do **not** use `=` as this will overwrite all elements for all games in the seed.
|
||||
* Instead, use `append`, `extend`, or `+=`.
|
||||
do **not** use `=` as this will overwrite all elements for all games in the seed.
|
||||
* Instead, use `append`, `extend`, or `+=`.
|
||||
|
||||
### Notable Caveats
|
||||
|
||||
|
Reference in New Issue
Block a user