Merge branch 'main' into main

This commit is contained in:
CookieCat
2024-05-18 00:19:35 -04:00
committed by GitHub
128 changed files with 14217 additions and 2960 deletions

View File

@@ -19,6 +19,9 @@
# A Link to the Past
/worlds/alttp/ @Berserker66
# Aquaria
/worlds/aquaria/ @tioui
# ArchipIDLE
/worlds/archipidle/ @LegendaryLinux
@@ -28,6 +31,9 @@
# Blasphemous
/worlds/blasphemous/ @TRPG0
# Bomb Rush Cyberfunk
/worlds/bomb_rush_cyberfunk/ @TRPG0
# Bumper Stickers
/worlds/bumpstik/ @FelicitusNeko
@@ -200,6 +206,9 @@
# Yoshi's Island
/worlds/yoshisisland/ @PinkSwitch
#Yu-Gi-Oh! Ultimate Masters: World Championship Tournament 2006
/worlds/yugioh06/ @rensen
# Zillion
/worlds/zillion/ @beauxq

View File

@@ -85,6 +85,25 @@ class ExampleWorld(World):
options: ExampleGameOptions
```
### Option Groups
Options may be categorized into groups for display on the WebHost. Option groups are displayed alphabetically on the
player-options and weighted-options pages. Options without a group name are categorized into a generic "Game Options"
group.
```python
from worlds.AutoWorld import WebWorld
from BaseClasses import OptionGroup
class MyWorldWeb(WebWorld):
option_groups = [
OptionGroup('Color Options', [
Options.ColorblindMode,
Options.FlashReduction,
Options.UIColors,
]),
]
```
### Option Checking
Options are parsed by `Generate.py` before the worlds are created, and then the option classes are created shortly after
world instantiation. These are created as attributes on the MultiWorld and can be accessed with
@@ -155,10 +174,12 @@ Gives the player starting hints for where the items defined here are.
Gives the player starting hints for the items on locations defined here.
### ExcludeLocations
Marks locations given here as `LocationProgressType.Excluded` so that progression items can't be placed on them.
Marks locations given here as `LocationProgressType.Excluded` so that neither progression nor useful items can be
placed on them.
### PriorityLocations
Marks locations given here as `LocationProgressType.Priority` forcing progression items on them.
Marks locations given here as `LocationProgressType.Priority` forcing progression items on them if any are available in
the pool.
### ItemLinks
Allows users to share their item pool with other players. Currently item links are per game. A link of one game between

View File

@@ -17,13 +17,14 @@ Then run any of the starting point scripts, like Generate.py, and the included M
required modules and after pressing enter proceed to install everything automatically.
After this, you should be able to run the programs.
* `Launcher.py` gives access to many components, including clients registered in `worlds/LauncherComponents.py`.
* The Launcher button "Generate Template Options" will generate default yamls for all worlds.
* With yaml(s) in the `Players` folder, `Generate.py` will generate the multiworld archive.
* `MultiServer.py`, with the filename of the generated archive as a command line parameter, will host the multiworld locally.
* `--log_network` is a command line parameter useful for debugging.
* `WebHost.py` will host the website on your computer.
* You can copy `docs/webhost configuration sample.yaml` to `config.yaml`
to change WebHost options (like the web hosting port number).
* As a side effect, `WebHost.py` creates the template yamls for all the games in `WebHostLib/static/generated`.
## Windows

View File

@@ -181,8 +181,7 @@ required, and will prevent progression and useful items from being placed at exc
#### Documenting Locations
Worlds can optionally provide a `location_descriptions` map which contains human-friendly descriptions of locations and
location groups. These descriptions will show up in location-selection options on the Weighted Options page. Extra
indentation and single newlines will be collapsed into spaces.
location groups. These descriptions will show up in location-selection options on the options pages.
```python
# locations.py
@@ -236,8 +235,7 @@ Other classifications include:
#### Documenting Items
Worlds can optionally provide an `item_descriptions` map which contains human-friendly descriptions of items and item
groups. These descriptions will show up in item-selection options on the Weighted Options page. Extra indentation and
single newlines will be collapsed into spaces.
groups. These descriptions will show up in item-selection options on the options pages.
```python
# items.py