WebWorld

class worlds.AutoWorld.WebWorld

Bases: object

Webhost integration

bug_report_page: str | None

display a link to a bug report page, most likely a link to a GitHub issue page.

game_info_languages: List[str] = ['en']

docs folder will be scanned for game info pages using this list in the format ‘{language}_{game_name}.md’

item_descriptions: Dict[str, str] = {}

An optional map from item names (or item group names) to brief descriptions for users.

location_descriptions: Dict[str, str] = {}

An optional map from location names (or location group names) to brief descriptions for users.

option_groups: ClassVar[List[OptionGroup]] = [('Item & Location Options', [<class 'Options.LocalItems'>, <class 'Options.NonLocalItems'>, <class 'Options.StartInventory'>, <class 'Options.StartInventoryPool'>, <class 'Options.StartHints'>, <class 'Options.StartLocationHints'>, <class 'Options.ExcludeLocations'>, <class 'Options.PriorityLocations'>, <class 'Options.ItemLinks'>], True)]

Ordered list of option groupings. Any options not set in a group will be placed in a pre-built “Game Options”.

options_page: bool | str = True

display a settings page. Can be a link to a specific page or external tool.

options_presets: Dict[str, Dict[str, Any]] = {}

A dictionary containing a collection of developer-defined game option presets.

rich_text_options_doc = False

Whether the WebHost should render Options’ docstrings as rich text.

If this is True, Options’ docstrings are interpreted as reStructuredText, the standard Python markup format. In the WebHost, they’re rendered to HTML so that lists, emphasis, and other rich text features are displayed properly.

If this is False, the docstrings are instead interpreted as plain text, and displayed as-is on the WebHost with whitespace preserved. For backwards compatibility, this is the default.

theme = 'grass'

Choose a theme for you /game/* pages. Available: dirt, grass, grassFlowers, ice, jungle, ocean, partyTime, stone

tutorials: List['Tutorial']

docs folder will also be scanned for tutorial guides. Each Tutorial class is to be used for one guide.