mirror of
https://github.com/ArchipelagoMW/Archipelago.git
synced 2026-03-22 07:35:37 -07:00
e1322df8b0
* APQuest: Explain game_name and supports_uri more in components.py Hopefully this can lead to more games implementing support for the "click on slot name -> everything launches automatically" functionality. * Update components.py * Update components.py
52 lines
3.3 KiB
Python
52 lines
3.3 KiB
Python
from worlds.LauncherComponents import Component, Type, components, launch
|
|
|
|
|
|
# The most common type of component is a client, but there are other components, such as sprite/palette adjusters.
|
|
# (Note: Some worlds distribute their clients as separate, standalone programs,
|
|
# while others include them in the apworld itself. Standalone clients are not an apworld component,
|
|
# although you could make a component that e.g. auto-installs and launches the standalone client for the user.)
|
|
# APQuest has a Python client inside the apworld that contains the entire game. This is a component.
|
|
# APQuest will not teach you how to make a client or any other type of component.
|
|
# However, let's quickly talk about how you register a component to be launchable from the Archipelago Launcher.
|
|
# First, you'll need a function that takes a list of args (e.g. from the command line) that launches your component.
|
|
def run_client(*args: str) -> None:
|
|
# Ideally, you should lazily import your component code so that it doesn't have to be loaded until necessary.
|
|
from .client.launch import launch_ap_quest_client
|
|
|
|
# Also, if your component has its own lifecycle, like if it is its own window that can be interacted with,
|
|
# you should use the LauncherComponents.launch helper (which itself calls launch_subprocess).
|
|
# This will create a subprocess for your component, launching it in a separate window from the Archipelago Launcher.
|
|
launch(launch_ap_quest_client, name="APQuest Client", args=args)
|
|
|
|
|
|
# You then add this function as a component by appending a Component instance to LauncherComponents.components.
|
|
# Now, it will show up in the Launcher with its display name,
|
|
# and when the user clicks on the "Open" button, your function will be run.
|
|
components.append(
|
|
Component(
|
|
"APQuest Client",
|
|
func=run_client,
|
|
game_name="APQuest",
|
|
component_type=Type.CLIENT,
|
|
supports_uri=True,
|
|
)
|
|
)
|
|
|
|
# There are two optional parameters that are worth drawing attention to here: "game_name" and "supports_uri".
|
|
# As you might know, on a room page on WebHost, clicking a slot name opens your locally installed Launcher
|
|
# and asks you if you want to open a Text Client.
|
|
# If you have "game_name" set on your Component, your user also gets the option to open that instead.
|
|
# Furthermore, if you have "supports_uri" set to True, your Component will be passed a uri as an arg.
|
|
# This uri contains the room url + port, the slot name, and the password.
|
|
# You can process this uri arg to automatically connect the user to their slot without having to type anything.
|
|
|
|
# As you can see above, the APQuest client has both of these parameters set.
|
|
# This means a user can click on the slot name of an APQuest slot on WebHost,
|
|
# then click "APQuest Client" instead of "Text Client" in the Launcher popup, and after a few seconds,
|
|
# they will be connected and playing the game without having to touch their keyboard once.
|
|
|
|
# Since a Component is just Python code, this doesn't just work with CommonClient-derived clients.
|
|
# You could forward this uri arg to your standalone C++/Java/.NET/whatever client as well,
|
|
# meaning just about every client can support this "Click on slot name -> Everything happens automatically" action.
|
|
# The author would like to see more clients be aware of this feature and try to support it.
|