1cc9c7a469
* Create RunFromSourceGuideForMac.md * Update and rename RunFromSourceGuideForMac.md to docs/RunFromSourceGuideForMac.md * Clarified the source code download. * Rename docs/RunFromSourceGuideForMac.md to worlds/generic/docs/RunFromSourceGuideForMac.md * Update __init__.py * Noted the case where a user might want EnemizerCLI * Updated document to reflect requested changes Updated to reflect the requested changes as well as including some information on virtual environments. * Added Capital Letters to SNIClient.py * Reworked Document Structure Numeric order of lists now makes sense and changed the virtual environment section to match Archipelago tradition. * Update __init__.py * Minor Changes for clarity's sake * Renamed file to make webhost happy * Changed mac guide filename
79 lines
3.4 KiB
Python
79 lines
3.4 KiB
Python
from typing import NamedTuple, Union
|
|
import logging
|
|
|
|
from BaseClasses import Item, Tutorial, ItemClassification
|
|
|
|
from ..AutoWorld import World, WebWorld
|
|
from NetUtils import SlotType
|
|
|
|
|
|
class GenericWeb(WebWorld):
|
|
advanced_settings = Tutorial('Advanced YAML Guide',
|
|
'A guide to reading YAML files and editing them to fully customize your game.',
|
|
'English', 'advanced_settings_en.md', 'advanced_settings/en',
|
|
['alwaysintreble', 'Alchav'])
|
|
commands = Tutorial('Archipelago Server and Client Commands',
|
|
'A guide detailing the commands available to the user when participating in an Archipelago session.',
|
|
'English', 'commands_en.md', 'commands/en', ['jat2980', 'Ijwu'])
|
|
mac = Tutorial('Archipelago Setup Guide for Mac', 'A guide detailing how to run Archipelago clients on macOS.',
|
|
'English', 'mac_en.md','mac/en', ['Bicoloursnake'])
|
|
plando = Tutorial('Archipelago Plando Guide', 'A guide to understanding and using plando for your game.',
|
|
'English', 'plando_en.md', 'plando/en', ['alwaysintreble', 'Alchav'])
|
|
setup = Tutorial('Multiworld Setup Tutorial',
|
|
'A guide to setting up the Archipelago software to generate and host multiworld games on your computer.',
|
|
'English', 'setup_en.md', 'setup/en', ['alwaysintreble'])
|
|
triggers = Tutorial('Archipelago Triggers Guide', 'A guide to setting up and using triggers in your game settings.',
|
|
'English', 'triggers_en.md', 'triggers/en', ['alwaysintreble'])
|
|
using_website = Tutorial('Archipelago Website User Guide',
|
|
'A guide to using the Archipelago website to generate multiworlds or host pre-generated multiworlds.',
|
|
'English', 'using_website_en.md', 'using_website/en', ['alwaysintreble'])
|
|
tutorials = [setup, using_website, mac, commands, advanced_settings, triggers, plando]
|
|
|
|
|
|
class GenericWorld(World):
|
|
game = "Archipelago"
|
|
topology_present = False
|
|
item_name_to_id = {
|
|
"Nothing": -1
|
|
}
|
|
location_name_to_id = {
|
|
"Cheat Console": -1,
|
|
"Server": -2
|
|
}
|
|
hidden = True
|
|
web = GenericWeb()
|
|
|
|
def generate_early(self):
|
|
self.world.player_types[self.player] = SlotType.spectator # mark as spectator
|
|
|
|
def create_item(self, name: str) -> Item:
|
|
if name == "Nothing":
|
|
return Item(name, ItemClassification.filler, -1, self.player)
|
|
raise KeyError(name)
|
|
|
|
|
|
class PlandoItem(NamedTuple):
|
|
item: str
|
|
location: str
|
|
world: Union[bool, str] = False # False -> own world, True -> not own world
|
|
from_pool: bool = True # if item should be removed from item pool
|
|
force: str = 'silent' # false -> warns if item not successfully placed. true -> errors out on failure to place item.
|
|
|
|
def warn(self, warning: str):
|
|
if self.force in ['true', 'fail', 'failure', 'none', 'false', 'warn', 'warning']:
|
|
logging.warning(f'{warning}')
|
|
else:
|
|
logging.debug(f'{warning}')
|
|
|
|
def failed(self, warning: str, exception=Exception):
|
|
if self.force in ['true', 'fail', 'failure']:
|
|
raise exception(warning)
|
|
else:
|
|
self.warn(warning)
|
|
|
|
|
|
class PlandoConnection(NamedTuple):
|
|
entrance: str
|
|
exit: str
|
|
direction: str # entrance, exit or both
|