monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Archipelago/SNIClient.py

1453 lines
66 KiB
Python
Raw Normal View History

LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
from __future__ import annotations
SNIClient: patch and launch SoE
2021-11-14 20:14:22 +00:00
import sys
unify clients and setup
2021-07-30 22:03:48 +00:00
import threading
Changes * Game end detection - Detect if the player finished their game, and announce it accordingly. * Add a client side /slow_mode option. (allows to delay receiving items when a massive amount of them come in, like from a forfeit.)
2020-04-25 03:07:28 +00:00
import time
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
import multiprocessing
expand rom auto_start to be customizable
2020-07-15 15:19:16 +00:00
import os
import subprocess
squashed commit of many breaking changes Dropping Support for Python 3.7; adding support for Python 3.9
2020-10-19 06:26:31 +00:00
import base64
Use shutil.move instead of os.replace, for compatibility
2021-01-21 22:58:30 +00:00
import shutil
Clients: logging fixes
2021-08-29 15:38:35 +00:00
import logging
import asyncio
log misunderstood network commands
2021-02-21 22:54:08 +00:00
from json import loads, dumps
Make clients identify themselves against server prep for potential later async auth system. Wanted to get this into the 2.3 client update.
2020-06-04 19:27:29 +00:00
ModuleUpdate: add it to a few more common entry points MinecraftClient: add requests import to requirements.txt
2022-04-07 08:19:18 +00:00
import ModuleUpdate
ModuleUpdate.update()
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
from Utils import init_logging
LttPClient: warn when connection is not made to SNI
2021-11-03 18:58:40 +00:00
Logging Revamp
2021-11-10 14:35:43 +00:00
if __name__ == "__main__":
Clients: log exception to logfile
2021-11-17 21:46:32 +00:00
init_logging("SNIClient", exception_logger="Client")
multiworld
2019-12-09 18:27:56 +00:00
re-implement auto-updates
2020-01-18 14:04:39 +00:00
import colorama
restore python 3.7 client compat
2020-06-06 20:54:09 +00:00
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
from NetUtils import *
update after merge from /main
2021-01-30 22:43:15 +00:00
from worlds.alttp import Regions, Shops
Core & LttP: remove 255 player limit
2021-10-21 06:15:47 +00:00
from worlds.alttp.Rom import ROM_PLAYER_LIMIT
[SM] added support for more than 255 players (will print Archipelago for higher player number) (#130) * added support for more than 255 players (will print Archipelago for higher player number)
2021-11-13 14:40:20 +00:00
from worlds.sm.Rom import ROM_PLAYER_LIMIT as SM_ROM_PLAYER_LIMIT
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
from worlds.smz3.Rom import ROM_PLAYER_LIMIT as SMZ3_ROM_PLAYER_LIMIT
implement server-client handshake and move hint system to optional colorama support
2020-02-16 14:32:40 +00:00
import Utils
Logging Revamp
2021-11-10 14:35:43 +00:00
from CommonClient import CommonContext, server_loop, console_loop, ClientCommandProcessor, gui_enabled, get_base_parser
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
from Patch import GAME_ALTTP, GAME_SM, GAME_SMZ3
CommonClient: allow running it as text client CommonClient: move logging init to library Setup: add TextClient
2021-09-30 07:09:21 +00:00
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger = logging.getLogger("SNES")
Convert WebUI to logging.Handler subclass
2021-01-19 05:37:35 +00:00
Factorio integration
2021-04-01 09:40:58 +00:00
from MultiServer import mark_raw
move cheating to server, with option to turn it off also, don't overwrite multisave if the resulting object is borked
2020-02-22 18:42:44 +00:00
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
LttP: refine DeathLink handling.
2021-11-11 15:09:08 +00:00
class DeathState(enum.IntEnum):
killing_player = 1
alive = 2
dead = 3
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
class SNIClientCommandProcessor(ClientCommandProcessor):
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
ctx: Context
Factorio integration
2021-04-01 09:40:58 +00:00
def _cmd_slow_mode(self, toggle: str = ""):
"""Toggle slow mode, which limits how fast you send / receive items."""
if toggle:
self.ctx.slow_mode = toggle.lower() in {"1", "true", "on"}
else:
self.ctx.slow_mode = not self.ctx.slow_mode
self.output(f"Setting slow mode to {self.ctx.slow_mode}")
@mark_raw
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
def _cmd_snes(self, snes_options: str = "") -> bool:
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
"""Connect to a snes. Optionally include network address of a snes to connect to,
SNIClient: make address optional for multi-snes
2022-02-20 03:16:34 +00:00
otherwise show available devices; and a SNES device number if more than one SNES is detected.
Examples: "/snes", "/snes 1", "/snes localhost:8080 1" """
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
snes_address = self.ctx.snes_address
snes_device_number = -1
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
options = snes_options.split()
num_options = len(options)
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
if num_options > 0:
SNIClient: make address optional for multi-snes
2022-02-20 03:16:34 +00:00
snes_device_number = int(options[0])
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
if num_options > 1:
SNIClient: make address optional for multi-snes
2022-02-20 03:16:34 +00:00
snes_address = options[0]
snes_device_number = int(options[1])
Factorio integration
2021-04-01 09:40:58 +00:00
self.ctx.snes_reconnect_address = None
CommonClient: consolidate shutdown handling
2021-11-21 01:02:40 +00:00
asyncio.create_task(snes_connect(self.ctx, snes_address, snes_device_number), name="SNES Connect")
Factorio integration
2021-04-01 09:40:58 +00:00
return True
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
Factorio integration
2021-04-01 09:40:58 +00:00
def _cmd_snes_close(self) -> bool:
"""Close connection to a currently connected snes"""
self.ctx.snes_reconnect_address = None
if self.ctx.snes_socket is not None and not self.ctx.snes_socket.closed:
asyncio.create_task(self.ctx.snes_socket.close())
return True
else:
return False
SNIClient: remove some debug stuff before release
2021-11-13 22:05:39 +00:00
# Left here for quick re-addition for debugging.
# def _cmd_snes_write(self, address, data):
# """Write the specified byte (base10) to the SNES' memory address (base16)."""
# if self.ctx.snes_state != SNESState.SNES_ATTACHED:
# self.output("No attached SNES Device.")
# return False
# snes_buffered_write(self.ctx, int(address, 16), bytes([int(data)]))
# asyncio.create_task(snes_flush_writes(self.ctx))
# self.output("Data Sent")
# return True
LttP: refine DeathLink handling.
2021-11-11 15:09:08 +00:00
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
# def _cmd_snes_read(self, address, size=1):
# """Read the SNES' memory address (base16)."""
# if self.ctx.snes_state != SNESState.SNES_ATTACHED:
# self.output("No attached SNES Device.")
# return False
# data = await snes_read(self.ctx, int(address, 16), size)
# self.output(f"Data Read: {data}")
# return True
LttPClient: add snes write command
2021-11-02 10:11:57 +00:00
Factorio integration
2021-04-01 09:40:58 +00:00
class Context(CommonContext):
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
command_processor = SNIClientCommandProcessor
Remove remaining ALTTP import from CommonClient.py and fix /missing in FactorioClient.py
2021-07-12 18:07:02 +00:00
game = "A Link to the Past"
Move remote_items and _start_inventory from world to client (#227)
2022-01-23 05:38:46 +00:00
items_handling = None # set in game_watcher
Remove remaining ALTTP import from CommonClient.py and fix /missing in FactorioClient.py
2021-07-12 18:07:02 +00:00
Merge together FactorioClient.py and FactorioClientGUI.py Add cmd arguments Add kivy style file, allowing users to modify it
2021-07-19 19:52:08 +00:00
def __init__(self, snes_address, server_address, password):
super(Context, self).__init__(server_address, password)
multiworld
2019-12-09 18:27:56 +00:00
Factorio integration
2021-04-01 09:40:58 +00:00
# snes stuff
self.snes_address = snes_address
multiworld
2019-12-09 18:27:56 +00:00
self.snes_socket = None
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
self.snes_state = SNESState.SNES_DISCONNECTED
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
self.snes_attached_device = None
self.snes_reconnect_address = None
multiworld
2019-12-09 18:27:56 +00:00
self.snes_recv_queue = asyncio.Queue()
self.snes_request_lock = asyncio.Lock()
self.snes_write_buffer = []
unify clients and setup
2021-07-30 22:03:48 +00:00
self.snes_connector_lock = threading.Lock()
LttP: refine DeathLink handling.
2021-11-11 15:09:08 +00:00
self.death_state = DeathState.alive # for death link flop behaviour
Fix task issues
2021-11-11 20:32:42 +00:00
self.killing_player_task = None
LttP: Add Allow collect option, default Off. (#414) * LttP: Add Allow collect option, default Off. * Add allow_collect to the sample yaml.
2022-04-05 01:54:49 +00:00
self.allow_collect = False
multiworld
2019-12-09 18:27:56 +00:00
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
self.awaiting_rom = False
self.rom = None
Don't clear locally visited locations if rom is same as previous on /snes after /snes_close (#98)
2020-06-02 14:38:23 +00:00
self.prev_rom = None
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
Factorio integration
2021-04-01 09:40:58 +00:00
async def connection_closed(self):
await super(Context, self).connection_closed()
self.awaiting_rom = False
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
Factorio integration
2021-04-01 09:40:58 +00:00
def event_invalid_slot(self):
if self.snes_socket is not None and not self.snes_socket.closed:
asyncio.create_task(self.snes_socket.close())
raise Exception('Invalid ROM detected, '
'please verify that you have loaded the correct rom and reconnect your snes (/snes)')
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
async def server_auth(self, password_requested: bool = False):
Factorio integration
2021-04-01 09:40:58 +00:00
if password_requested and not self.password:
await super(Context, self).server_auth(password_requested)
if self.rom is None:
self.awaiting_rom = True
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.info(
Factorio integration
2021-04-01 09:40:58 +00:00
'No ROM detected, awaiting snes connection to authenticate to the multiworld server (/snes)')
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
return
Factorio integration
2021-04-01 09:40:58 +00:00
self.awaiting_rom = False
self.auth = self.rom
auth = base64.b64encode(self.rom).decode()
CommonClient: consolidate Connect packet sending
2021-11-21 01:50:24 +00:00
await self.send_connect(name=auth)
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
def on_deathlink(self, data: dict):
Fix task issues
2021-11-11 20:32:42 +00:00
if not self.killing_player_task or self.killing_player_task.done():
self.killing_player_task = asyncio.create_task(deathlink_kill_player(self))
MultiServer: implement Tracker tag Docs: add InvalidPacket Docs: add known Tags Docs: add DeathLink LttPClient: potentially fix DeathLink chaining
2021-11-04 12:23:13 +00:00
super(Context, self).on_deathlink(data)
Hollow Knight integration (prototype status)
2021-02-21 19:17:24 +00:00
Fix error in SNIClient
2021-11-12 14:48:23 +00:00
async def handle_deathlink_state(self, currently_dead: bool):
Post-Merge Cleanup #2
2021-11-12 13:58:48 +00:00
# in this state we only care about triggering a death send
if self.death_state == DeathState.alive:
if currently_dead:
self.death_state = DeathState.dead
await self.send_death()
# in this state we care about confirming a kill, to move state to dead
elif self.death_state == DeathState.killing_player:
# this is being handled in deathlink_kill_player(ctx) already
pass
# in this state we wait until the player is alive again
elif self.death_state == DeathState.dead:
if not currently_dead:
self.death_state = DeathState.alive
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
def on_package(self, cmd: str, args: dict):
if cmd in {"Connected", "RoomUpdate"}:
if "checked_locations" in args and args["checked_locations"]:
new_locations = set(args["checked_locations"])
self.checked_locations |= new_locations
self.locations_scouted |= new_locations
# Items belonging to the player should not be marked as checked in game, since the player will likely need that item.
# Once the games handled by SNIClient gets made to be remote items, this will no longer be needed.
asyncio.create_task(self.send_msgs([{"cmd": "LocationScouts", "locations": list(new_locations)}]))
Convert WebUI to logging.Handler subclass
2021-01-19 05:37:35 +00:00
LttP: refine DeathLink handling.
2021-11-11 15:09:08 +00:00
async def deathlink_kill_player(ctx: Context):
Move death link byte to sram
2021-11-11 20:07:17 +00:00
ctx.death_state = DeathState.killing_player
Fix task issues
2021-11-11 20:32:42 +00:00
while ctx.death_state == DeathState.killing_player and \
ctx.snes_state == SNESState.SNES_ATTACHED:
Post-Merge Cleanup
2021-11-12 13:36:34 +00:00
if ctx.game == GAME_ALTTP:
Death Link during a crystal/pendant cutscene no longer softlocks while connected.
2022-01-26 15:54:09 +00:00
invincible = await snes_read(ctx, WRAM_START + 0x037B, 1)
last_health = await snes_read(ctx, WRAM_START + 0xF36D, 1)
await asyncio.sleep(0.25)
health = await snes_read(ctx, WRAM_START + 0xF36D, 1)
if not invincible or not last_health or not health:
ctx.death_state = DeathState.dead
ctx.last_death_link = time.time()
continue
if not invincible[0] and last_health[0] == health[0]:
snes_buffered_write(ctx, WRAM_START + 0xF36D, bytes([0])) # set current health to 0
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
snes_buffered_write(ctx, WRAM_START + 0x0373,
bytes([8])) # deal 1 full heart of damage at next opportunity
Post-Merge Cleanup
2021-11-12 13:36:34 +00:00
elif ctx.game == GAME_SM:
[SM] Add support for Remote Items (#317)
2022-03-21 04:34:47 +00:00
snes_buffered_write(ctx, WRAM_START + 0x09C2, bytes([1, 0])) # set current health to 1 (to prevent saving with 0 energy)
snes_buffered_write(ctx, WRAM_START + 0x0A50, bytes([255])) # deal 255 of damage at next opportunity
SM update (#147) * fixed generations failing when only bosses are unreachable * - replaced setting maxDiff to infinity with a bool only affecting boss logics if only bosses are left to finish * fixed failling generations when using 'fun' settings Accessibility checks are forced to 'items' if restricted locations are used by VARIA following usage of 'fun' settings * fixed debug logger * removed unsupported "suits_restriction" option * fixed generations failing when only bosses are unreachable (using a less intrusive approach for AP) * - fixed deathlink emptying reserves - added death_link_survive option that lets player survive when receiving a deathlink if the have non-empty reserves * - merged death_link and death_link_survive options
2021-12-02 05:11:42 +00:00
if not ctx.death_link_allow_survive:
snes_buffered_write(ctx, WRAM_START + 0x09D6, bytes([0, 0])) # set current reserve to 0
Move death link byte to sram
2021-11-11 20:07:17 +00:00
await snes_flush_writes(ctx)
await asyncio.sleep(1)
MultiServer: delete unused function
2022-01-28 08:29:29 +00:00
Post-Merge Cleanup
2021-11-12 13:36:34 +00:00
if ctx.game == GAME_ALTTP:
gamemode = await snes_read(ctx, WRAM_START + 0x10, 1)
SM update (#147) * fixed generations failing when only bosses are unreachable * - replaced setting maxDiff to infinity with a bool only affecting boss logics if only bosses are left to finish * fixed failling generations when using 'fun' settings Accessibility checks are forced to 'items' if restricted locations are used by VARIA following usage of 'fun' settings * fixed debug logger * removed unsupported "suits_restriction" option * fixed generations failing when only bosses are unreachable (using a less intrusive approach for AP) * - fixed deathlink emptying reserves - added death_link_survive option that lets player survive when receiving a deathlink if the have non-empty reserves * - merged death_link and death_link_survive options
2021-12-02 05:11:42 +00:00
if not gamemode or gamemode[0] in DEATH_MODES:
ctx.death_state = DeathState.dead
Post-Merge Cleanup
2021-11-12 13:36:34 +00:00
elif ctx.game == GAME_SM:
gamemode = await snes_read(ctx, WRAM_START + 0x0998, 1)
SM update (#147) * fixed generations failing when only bosses are unreachable * - replaced setting maxDiff to infinity with a bool only affecting boss logics if only bosses are left to finish * fixed failling generations when using 'fun' settings Accessibility checks are forced to 'items' if restricted locations are used by VARIA following usage of 'fun' settings * fixed debug logger * removed unsupported "suits_restriction" option * fixed generations failing when only bosses are unreachable (using a less intrusive approach for AP) * - fixed deathlink emptying reserves - added death_link_survive option that lets player survive when receiving a deathlink if the have non-empty reserves * - merged death_link and death_link_survive options
2021-12-02 05:11:42 +00:00
health = await snes_read(ctx, WRAM_START + 0x09C2, 2)
if health is not None:
health = health[0] | (health[1] << 8)
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
if not gamemode or gamemode[0] in SM_DEATH_MODES or (
ctx.death_link_allow_survive and health is not None and health > 0):
SM update (#147) * fixed generations failing when only bosses are unreachable * - replaced setting maxDiff to infinity with a bool only affecting boss logics if only bosses are left to finish * fixed failling generations when using 'fun' settings Accessibility checks are forced to 'items' if restricted locations are used by VARIA following usage of 'fun' settings * fixed debug logger * removed unsupported "suits_restriction" option * fixed generations failing when only bosses are unreachable (using a less intrusive approach for AP) * - fixed deathlink emptying reserves - added death_link_survive option that lets player survive when receiving a deathlink if the have non-empty reserves * - merged death_link and death_link_survive options
2021-12-02 05:11:42 +00:00
ctx.death_state = DeathState.dead
Move death link byte to sram
2021-11-11 20:07:17 +00:00
ctx.last_death_link = time.time()
LttP: refine DeathLink handling.
2021-11-11 15:09:08 +00:00
Delay consecutive reconnects
2020-09-01 19:45:01 +00:00
SNES_RECONNECT_DELAY = 5
multiworld
2019-12-09 18:27:56 +00:00
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
# LttP
multiworld
2019-12-09 18:27:56 +00:00
ROM_START = 0x000000
WRAM_START = 0xF50000
WRAM_SIZE = 0x20000
SRAM_START = 0xE00000
ROMNAME_START = SRAM_START + 0x2000
ROMNAME_SIZE = 0x15
INGAME_MODES = {0x07, 0x09, 0x0b}
Changes * Game end detection - Detect if the player finished their game, and announce it accordingly. * Add a client side /slow_mode option. (allows to delay receiving items when a massive amount of them come in, like from a forfeit.)
2020-04-25 03:07:28 +00:00
ENDGAME_MODES = {0x19, 0x1a}
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
DEATH_MODES = {0x12}
multiworld
2019-12-09 18:27:56 +00:00
SAVEDATA_START = WRAM_START + 0xF000
SAVEDATA_SIZE = 0x500
--remote_items toggle: items will no longer be stored in the rom, a connection to a multiworld server will be required to receive them
2020-01-18 08:50:12 +00:00
RECV_PROGRESS_ADDR = SAVEDATA_START + 0x4D0 # 2 bytes
RECV_ITEM_ADDR = SAVEDATA_START + 0x4D2 # 1 byte
RECV_ITEM_PLAYER_ADDR = SAVEDATA_START + 0x4D3 # 1 byte
ROOMID_ADDR = SAVEDATA_START + 0x4D4 # 2 bytes
ROOMDATA_ADDR = SAVEDATA_START + 0x4D6 # 1 byte
SCOUT_LOCATION_ADDR = SAVEDATA_START + 0x4D7 # 1 byte
SCOUTREPLY_LOCATION_ADDR = SAVEDATA_START + 0x4D8 # 1 byte
SCOUTREPLY_ITEM_ADDR = SAVEDATA_START + 0x4D9 # 1 byte
SCOUTREPLY_PLAYER_ADDR = SAVEDATA_START + 0x4DA # 1 byte
Fixes to clients/servers for shop checks
2020-12-15 08:34:22 +00:00
SHOP_ADDR = SAVEDATA_START + 0x302 # 2 bytes
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
SHOP_LEN = (len(Shops.shop_table) * 3) + 5
Fixes to clients/servers for shop checks
2020-12-15 08:34:22 +00:00
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
DEATH_LINK_ACTIVE_ADDR = ROMNAME_START + 0x15 # 1 byte
# SM
SM: remove SNIClient read of duplicative ROM name (#340)
2022-03-24 15:40:02 +00:00
SM_ROMNAME_START = 0x007FC0
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
SM_INGAME_MODES = {0x07, 0x09, 0x0b}
SM_ENDGAME_MODES = {0x26, 0x27}
SM_DEATH_MODES = {0x15, 0x17, 0x18, 0x19, 0x1A}
SM_RECV_PROGRESS_ADDR = SRAM_START + 0x2000 # 2 bytes
SM_RECV_ITEM_ADDR = SAVEDATA_START + 0x4D2 # 1 byte
SM_RECV_ITEM_PLAYER_ADDR = SAVEDATA_START + 0x4D3 # 1 byte
SM_DEATH_LINK_ACTIVE_ADDR = ROM_START + 0x277f04 # 1 byte
[SM] Add support for Remote Items (#317)
2022-03-21 04:34:47 +00:00
SM_REMOTE_ITEM_FLAG_ADDR = ROM_START + 0x277f06 # 1 byte
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
# SMZ3
SMZ3_ROMNAME_START = 0x00FFC0
SMZ3_INGAME_MODES = {0x07, 0x09, 0x0b}
SMZ3_ENDGAME_MODES = {0x26, 0x27}
SMZ3_DEATH_MODES = {0x15, 0x17, 0x18, 0x19, 0x1A}
SMZ3_RECV_PROGRESS_ADDR = SRAM_START + 0x4000 # 2 bytes
SMZ3_RECV_ITEM_ADDR = SAVEDATA_START + 0x4D2 # 1 byte
SMZ3_RECV_ITEM_PLAYER_ADDR = SAVEDATA_START + 0x4D3 # 1 byte
Move Shop related stuff to a Shops module
2021-01-16 01:23:23 +00:00
location_shop_ids = set([info[0] for name, info in Shops.shop_table.items()])
multiworld
2019-12-09 18:27:56 +00:00
location_table_uw = {"Blind's Hideout - Top": (0x11d, 0x10),
"Blind's Hideout - Left": (0x11d, 0x20),
"Blind's Hideout - Right": (0x11d, 0x40),
"Blind's Hideout - Far Left": (0x11d, 0x80),
"Blind's Hideout - Far Right": (0x11d, 0x100),
'Secret Passage': (0x55, 0x10),
'Waterfall Fairy - Left': (0x114, 0x10),
'Waterfall Fairy - Right': (0x114, 0x20),
"King's Tomb": (0x113, 0x10),
'Floodgate Chest': (0x10b, 0x10),
"Link's House": (0x104, 0x10),
'Kakariko Tavern': (0x103, 0x10),
'Chicken House': (0x108, 0x10),
"Aginah's Cave": (0x10a, 0x10),
"Sahasrahla's Hut - Left": (0x105, 0x10),
"Sahasrahla's Hut - Middle": (0x105, 0x20),
"Sahasrahla's Hut - Right": (0x105, 0x40),
'Kakariko Well - Top': (0x2f, 0x10),
'Kakariko Well - Left': (0x2f, 0x20),
'Kakariko Well - Middle': (0x2f, 0x40),
'Kakariko Well - Right': (0x2f, 0x80),
'Kakariko Well - Bottom': (0x2f, 0x100),
'Lost Woods Hideout': (0xe1, 0x200),
'Lumberjack Tree': (0xe2, 0x200),
'Cave 45': (0x11b, 0x400),
'Graveyard Cave': (0x11b, 0x200),
'Checkerboard Cave': (0x126, 0x200),
'Mini Moldorm Cave - Far Left': (0x123, 0x10),
'Mini Moldorm Cave - Left': (0x123, 0x20),
'Mini Moldorm Cave - Right': (0x123, 0x40),
'Mini Moldorm Cave - Far Right': (0x123, 0x80),
'Mini Moldorm Cave - Generous Guy': (0x123, 0x400),
'Ice Rod Cave': (0x120, 0x10),
'Bonk Rock Cave': (0x124, 0x10),
'Desert Palace - Big Chest': (0x73, 0x10),
'Desert Palace - Torch': (0x73, 0x400),
'Desert Palace - Map Chest': (0x74, 0x10),
'Desert Palace - Compass Chest': (0x85, 0x10),
'Desert Palace - Big Key Chest': (0x75, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Desert Palace - Desert Tiles 1 Pot Key': (0x63, 0x400),
'Desert Palace - Beamos Hall Pot Key': (0x53, 0x400),
'Desert Palace - Desert Tiles 2 Pot Key': (0x43, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Desert Palace - Boss': (0x33, 0x800),
'Eastern Palace - Compass Chest': (0xa8, 0x10),
'Eastern Palace - Big Chest': (0xa9, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Eastern Palace - Dark Square Pot Key': (0xba, 0x400),
'Eastern Palace - Dark Eyegore Key Drop': (0x99, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Eastern Palace - Cannonball Chest': (0xb9, 0x10),
'Eastern Palace - Big Key Chest': (0xb8, 0x10),
'Eastern Palace - Map Chest': (0xaa, 0x10),
'Eastern Palace - Boss': (0xc8, 0x800),
'Hyrule Castle - Boomerang Chest': (0x71, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Hyrule Castle - Boomerang Guard Key Drop': (0x71, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Hyrule Castle - Map Chest': (0x72, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Hyrule Castle - Map Guard Key Drop': (0x72, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
"Hyrule Castle - Zelda's Chest": (0x80, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Hyrule Castle - Big Key Drop': (0x80, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Sewers - Dark Cross': (0x32, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Hyrule Castle - Key Rat Key Drop': (0x21, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Sewers - Secret Room - Left': (0x11, 0x10),
'Sewers - Secret Room - Middle': (0x11, 0x20),
'Sewers - Secret Room - Right': (0x11, 0x40),
'Sanctuary': (0x12, 0x10),
'Castle Tower - Room 03': (0xe0, 0x10),
'Castle Tower - Dark Maze': (0xd0, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Castle Tower - Dark Archer Key Drop': (0xc0, 0x400),
'Castle Tower - Circle of Pots Key Drop': (0xb0, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Spectacle Rock Cave': (0xea, 0x400),
'Paradox Cave Lower - Far Left': (0xef, 0x10),
'Paradox Cave Lower - Left': (0xef, 0x20),
'Paradox Cave Lower - Right': (0xef, 0x40),
'Paradox Cave Lower - Far Right': (0xef, 0x80),
'Paradox Cave Lower - Middle': (0xef, 0x100),
'Paradox Cave Upper - Left': (0xff, 0x10),
'Paradox Cave Upper - Right': (0xff, 0x20),
'Spiral Cave': (0xfe, 0x10),
'Tower of Hera - Basement Cage': (0x87, 0x400),
'Tower of Hera - Map Chest': (0x77, 0x10),
'Tower of Hera - Big Key Chest': (0x87, 0x10),
'Tower of Hera - Compass Chest': (0x27, 0x20),
'Tower of Hera - Big Chest': (0x27, 0x10),
'Tower of Hera - Boss': (0x7, 0x800),
'Hype Cave - Top': (0x11e, 0x10),
'Hype Cave - Middle Right': (0x11e, 0x20),
'Hype Cave - Middle Left': (0x11e, 0x40),
'Hype Cave - Bottom': (0x11e, 0x80),
'Hype Cave - Generous Guy': (0x11e, 0x400),
'Peg Cave': (0x127, 0x400),
'Pyramid Fairy - Left': (0x116, 0x10),
'Pyramid Fairy - Right': (0x116, 0x20),
'Brewery': (0x106, 0x10),
'C-Shaped House': (0x11c, 0x10),
'Chest Game': (0x106, 0x400),
'Mire Shed - Left': (0x10d, 0x10),
'Mire Shed - Right': (0x10d, 0x20),
'Superbunny Cave - Top': (0xf8, 0x10),
'Superbunny Cave - Bottom': (0xf8, 0x20),
'Spike Cave': (0x117, 0x10),
'Hookshot Cave - Top Right': (0x3c, 0x10),
'Hookshot Cave - Top Left': (0x3c, 0x20),
'Hookshot Cave - Bottom Right': (0x3c, 0x80),
'Hookshot Cave - Bottom Left': (0x3c, 0x40),
'Mimic Cave': (0x10c, 0x10),
'Swamp Palace - Entrance': (0x28, 0x10),
'Swamp Palace - Map Chest': (0x37, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Swamp Palace - Pot Row Pot Key': (0x38, 0x400),
'Swamp Palace - Trench 1 Pot Key': (0x37, 0x400),
'Swamp Palace - Hookshot Pot Key': (0x36, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Swamp Palace - Big Chest': (0x36, 0x10),
'Swamp Palace - Compass Chest': (0x46, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Swamp Palace - Trench 2 Pot Key': (0x35, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Swamp Palace - Big Key Chest': (0x35, 0x10),
'Swamp Palace - West Chest': (0x34, 0x10),
'Swamp Palace - Flooded Room - Left': (0x76, 0x10),
'Swamp Palace - Flooded Room - Right': (0x76, 0x20),
'Swamp Palace - Waterfall Room': (0x66, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Swamp Palace - Waterway Pot Key': (0x16, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Swamp Palace - Boss': (0x6, 0x800),
"Thieves' Town - Big Key Chest": (0xdb, 0x20),
"Thieves' Town - Map Chest": (0xdb, 0x10),
"Thieves' Town - Compass Chest": (0xdc, 0x10),
"Thieves' Town - Ambush Chest": (0xcb, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
"Thieves' Town - Hallway Pot Key": (0xbc, 0x400),
"Thieves' Town - Spike Switch Pot Key": (0xab, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
"Thieves' Town - Attic": (0x65, 0x10),
"Thieves' Town - Big Chest": (0x44, 0x10),
"Thieves' Town - Blind's Cell": (0x45, 0x10),
"Thieves' Town - Boss": (0xac, 0x800),
'Skull Woods - Compass Chest': (0x67, 0x10),
'Skull Woods - Map Chest': (0x58, 0x20),
'Skull Woods - Big Chest': (0x58, 0x10),
'Skull Woods - Pot Prison': (0x57, 0x20),
'Skull Woods - Pinball Room': (0x68, 0x10),
'Skull Woods - Big Key Chest': (0x57, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Skull Woods - West Lobby Pot Key': (0x56, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Skull Woods - Bridge Room': (0x59, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Skull Woods - Spike Corner Key Drop': (0x39, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Skull Woods - Boss': (0x29, 0x800),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Ice Palace - Jelly Key Drop': (0x0e, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Ice Palace - Compass Chest': (0x2e, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Ice Palace - Conveyor Key Drop': (0x3e, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Ice Palace - Freezor Chest': (0x7e, 0x10),
'Ice Palace - Big Chest': (0x9e, 0x10),
'Ice Palace - Iced T Room': (0xae, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Ice Palace - Many Pots Pot Key': (0x9f, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Ice Palace - Spike Room': (0x5f, 0x10),
'Ice Palace - Big Key Chest': (0x1f, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Ice Palace - Hammer Block Key Drop': (0x3f, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Ice Palace - Map Chest': (0x3f, 0x10),
'Ice Palace - Boss': (0xde, 0x800),
'Misery Mire - Big Chest': (0xc3, 0x10),
'Misery Mire - Map Chest': (0xc3, 0x20),
'Misery Mire - Main Lobby': (0xc2, 0x10),
'Misery Mire - Bridge Chest': (0xa2, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Misery Mire - Spikes Pot Key': (0xb3, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Misery Mire - Spike Chest': (0xb3, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Misery Mire - Fishbone Pot Key': (0xa1, 0x400),
'Misery Mire - Conveyor Crystal Key Drop': (0xc1, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Misery Mire - Compass Chest': (0xc1, 0x10),
'Misery Mire - Big Key Chest': (0xd1, 0x10),
'Misery Mire - Boss': (0x90, 0x800),
'Turtle Rock - Compass Chest': (0xd6, 0x10),
'Turtle Rock - Roller Room - Left': (0xb7, 0x10),
'Turtle Rock - Roller Room - Right': (0xb7, 0x20),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Turtle Rock - Pokey 1 Key Drop': (0xb6, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Turtle Rock - Chain Chomps': (0xb6, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Turtle Rock - Pokey 2 Key Drop': (0x13, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Turtle Rock - Big Key Chest': (0x14, 0x10),
'Turtle Rock - Big Chest': (0x24, 0x10),
'Turtle Rock - Crystaroller Room': (0x4, 0x10),
'Turtle Rock - Eye Bridge - Bottom Left': (0xd5, 0x80),
'Turtle Rock - Eye Bridge - Bottom Right': (0xd5, 0x40),
'Turtle Rock - Eye Bridge - Top Left': (0xd5, 0x20),
'Turtle Rock - Eye Bridge - Top Right': (0xd5, 0x10),
'Turtle Rock - Boss': (0xa4, 0x800),
'Palace of Darkness - Shooter Room': (0x9, 0x10),
'Palace of Darkness - The Arena - Bridge': (0x2a, 0x20),
'Palace of Darkness - Stalfos Basement': (0xa, 0x10),
'Palace of Darkness - Big Key Chest': (0x3a, 0x10),
'Palace of Darkness - The Arena - Ledge': (0x2a, 0x10),
'Palace of Darkness - Map Chest': (0x2b, 0x10),
'Palace of Darkness - Compass Chest': (0x1a, 0x20),
'Palace of Darkness - Dark Basement - Left': (0x6a, 0x10),
'Palace of Darkness - Dark Basement - Right': (0x6a, 0x20),
'Palace of Darkness - Dark Maze - Top': (0x19, 0x10),
'Palace of Darkness - Dark Maze - Bottom': (0x19, 0x20),
'Palace of Darkness - Big Chest': (0x1a, 0x10),
'Palace of Darkness - Harmless Hellway': (0x1a, 0x40),
'Palace of Darkness - Boss': (0x5a, 0x800),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Ganons Tower - Conveyor Cross Pot Key': (0x8b, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
"Ganons Tower - Bob's Torch": (0x8c, 0x400),
'Ganons Tower - Hope Room - Left': (0x8c, 0x20),
'Ganons Tower - Hope Room - Right': (0x8c, 0x40),
'Ganons Tower - Tile Room': (0x8d, 0x10),
'Ganons Tower - Compass Room - Top Left': (0x9d, 0x10),
'Ganons Tower - Compass Room - Top Right': (0x9d, 0x20),
'Ganons Tower - Compass Room - Bottom Left': (0x9d, 0x40),
'Ganons Tower - Compass Room - Bottom Right': (0x9d, 0x80),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Ganons Tower - Conveyor Star Pits Pot Key': (0x7b, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Ganons Tower - DMs Room - Top Left': (0x7b, 0x10),
'Ganons Tower - DMs Room - Top Right': (0x7b, 0x20),
'Ganons Tower - DMs Room - Bottom Left': (0x7b, 0x40),
'Ganons Tower - DMs Room - Bottom Right': (0x7b, 0x80),
'Ganons Tower - Map Chest': (0x8b, 0x10),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Ganons Tower - Double Switch Pot Key': (0x9b, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Ganons Tower - Firesnake Room': (0x7d, 0x10),
'Ganons Tower - Randomizer Room - Top Left': (0x7c, 0x10),
'Ganons Tower - Randomizer Room - Top Right': (0x7c, 0x20),
'Ganons Tower - Randomizer Room - Bottom Left': (0x7c, 0x40),
'Ganons Tower - Randomizer Room - Bottom Right': (0x7c, 0x80),
"Ganons Tower - Bob's Chest": (0x8c, 0x80),
'Ganons Tower - Big Chest': (0x8c, 0x10),
'Ganons Tower - Big Key Room - Left': (0x1c, 0x20),
'Ganons Tower - Big Key Room - Right': (0x1c, 0x40),
'Ganons Tower - Big Key Chest': (0x1c, 0x10),
'Ganons Tower - Mini Helmasaur Room - Left': (0x3d, 0x10),
'Ganons Tower - Mini Helmasaur Room - Right': (0x3d, 0x20),
Insert key drop locations in alphabetical order.
2020-10-28 08:48:22 +00:00
'Ganons Tower - Mini Helmasaur Key Drop': (0x3d, 0x400),
multiworld
2019-12-09 18:27:56 +00:00
'Ganons Tower - Pre-Moldorm Chest': (0x3d, 0x40),
'Ganons Tower - Validation Chest': (0x4d, 0x10)}
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
Link to the Past Block collection of bosses. (#395)
2022-04-02 23:39:28 +00:00
boss_locations = {Regions.lookup_name_to_id[name] for name in {'Eastern Palace - Boss',
'Desert Palace - Boss',
'Tower of Hera - Boss',
'Palace of Darkness - Boss',
'Swamp Palace - Boss',
'Skull Woods - Boss',
"Thieves' Town - Boss",
'Ice Palace - Boss',
'Misery Mire - Boss',
'Turtle Rock - Boss'}}
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
location_table_uw_id = {Regions.lookup_name_to_id[name]: data for name, data in location_table_uw.items()}
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
multiworld
2019-12-09 18:27:56 +00:00
location_table_npc = {'Mushroom': 0x1000,
'King Zora': 0x2,
'Sahasrahla': 0x10,
'Blacksmith': 0x400,
'Magic Bat': 0x8000,
'Sick Kid': 0x4,
'Library': 0x80,
'Potion Shop': 0x2000,
'Old Man': 0x1,
'Ether Tablet': 0x100,
'Catfish': 0x20,
'Stumpy': 0x8,
'Bombos Tablet': 0x200}
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
location_table_npc_id = {Regions.lookup_name_to_id[name]: data for name, data in location_table_npc.items()}
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
multiworld
2019-12-09 18:27:56 +00:00
location_table_ow = {'Flute Spot': 0x2a,
'Sunken Treasure': 0x3b,
"Zora's Ledge": 0x81,
'Lake Hylia Island': 0x35,
'Maze Race': 0x28,
'Desert Ledge': 0x30,
'Master Sword Pedestal': 0x80,
'Spectacle Rock': 0x3,
'Pyramid': 0x5b,
'Digging Game': 0x68,
'Bumper Cave Ledge': 0x4a,
'Floating Island': 0x5}
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
location_table_ow_id = {Regions.lookup_name_to_id[name]: data for name, data in location_table_ow.items()}
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
multiworld
2019-12-09 18:27:56 +00:00
location_table_misc = {'Bottle Merchant': (0x3c9, 0x2),
'Purple Chest': (0x3c9, 0x10),
"Link's Uncle": (0x3c6, 0x1),
'Hobo': (0x3c9, 0x1)}
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
location_table_misc_id = {Regions.lookup_name_to_id[name]: data for name, data in location_table_misc.items()}
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
class SNESState(enum.IntEnum):
SNES_DISCONNECTED = 0
SNES_CONNECTING = 1
SNES_CONNECTED = 2
SNES_ATTACHED = 3
multiworld
2019-12-09 18:27:56 +00:00
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
def launch_sni(ctx: Context):
sni_path = Utils.get_options()["lttp_options"]["sni"]
multiworld
2019-12-09 18:27:56 +00:00
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
if not os.path.isdir(sni_path):
sni_path = Utils.local_path(sni_path)
if os.path.isdir(sni_path):
SNIClient: make SNI finder a bit smarter
2022-01-01 14:46:08 +00:00
dir_entry: os.DirEntry
for dir_entry in os.scandir(sni_path):
if dir_entry.is_file():
lower_file = dir_entry.name.lower()
if (lower_file.startswith("sni.") and not lower_file.endswith(".proto")) or (lower_file == "sni"):
sni_path = dir_entry.path
break
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
if os.path.isfile(sni_path):
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.info(f"Attempting to start {sni_path}")
Clients: consolidate argument parsing
2021-11-09 11:53:05 +00:00
import sys
if not sys.stdout: # if it spawns a visible console, may as well populate it
Use absolute path when starting SNI Causes reliability issues when relative path is used.
2021-12-27 14:29:09 +00:00
subprocess.Popen(os.path.abspath(sni_path), cwd=os.path.dirname(sni_path))
some post unification cleanup.
2021-07-30 23:40:27 +00:00
else:
Setup, Launcher, Linux Support (#359)
2022-03-31 03:08:15 +00:00
proc = subprocess.Popen(os.path.abspath(sni_path), cwd=os.path.dirname(sni_path),
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
try:
proc.wait(.1) # wait a bit to see if startup fails (missing dependencies)
snes_logger.info('Failed to start SNI. Try running it externally for error output.')
except subprocess.TimeoutExpired:
pass # seems to be running
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
else:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.info(
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
f"Attempt to start SNI was aborted as path {sni_path} was not found, "
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
f"please start it yourself if it is not running")
multiworld
2019-12-09 18:27:56 +00:00
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
async def _snes_connect(ctx: Context, address: str):
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
address = f"ws://{address}" if "://" not in address else address
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.info("Connecting to SNI at %s ..." % address)
Make Client wait for QUSB2SNES connection and devices, then auto-connect
2020-03-06 23:07:32 +00:00
seen_problems = set()
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
succesful = False
while not succesful:
Make Client wait for QUSB2SNES connection and devices, then auto-connect
2020-03-06 23:07:32 +00:00
try:
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
snes_socket = await websockets.connect(address, ping_timeout=None, ping_interval=None)
succesful = True
Make Client wait for QUSB2SNES connection and devices, then auto-connect
2020-03-06 23:07:32 +00:00
except Exception as e:
problem = "%s" % e
# only tell the user about new problems, otherwise silently lay in wait for a working connection
if problem not in seen_problems:
seen_problems.add(problem)
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.error(f"Error connecting to SNI ({problem})")
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
the setup experience
2020-04-07 02:18:26 +00:00
if len(seen_problems) == 1:
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
# this is the first problem. Let's try launching SNI if it isn't already running
launch_sni(ctx)
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
await asyncio.sleep(1)
else:
return snes_socket
clean qusb2snes launch code a bit
2020-04-12 02:44:03 +00:00
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
async def get_snes_devices(ctx: Context):
socket = await _snes_connect(ctx, ctx.snes_address) # establish new connection to poll
DeviceList_Request = {
"Opcode": "DeviceList",
"Space": "SNES"
}
squashed commit of many breaking changes Dropping Support for Python 3.7; adding support for Python 3.9
2020-10-19 06:26:31 +00:00
await socket.send(dumps(DeviceList_Request))
clean qusb2snes launch code a bit
2020-04-12 02:44:03 +00:00
squashed commit of many breaking changes Dropping Support for Python 3.7; adding support for Python 3.9
2020-10-19 06:26:31 +00:00
reply = loads(await socket.recv())
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
devices = reply['Results'] if 'Results' in reply and len(reply['Results']) > 0 else None
the setup experience
2020-04-07 02:18:26 +00:00
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
if not devices:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.info('No SNES device found. Please connect a SNES device to SNI.')
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
while not devices:
Make Client wait for QUSB2SNES connection and devices, then auto-connect
2020-03-06 23:07:32 +00:00
await asyncio.sleep(1)
squashed commit of many breaking changes Dropping Support for Python 3.7; adding support for Python 3.9
2020-10-19 06:26:31 +00:00
await socket.send(dumps(DeviceList_Request))
reply = loads(await socket.recv())
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
devices = reply['Results'] if 'Results' in reply and len(reply['Results']) > 0 else None
LttPClient: warn when connection is not made to SNI
2021-11-03 18:58:40 +00:00
await verify_snes_app(socket)
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
await socket.close()
return devices
multiworld
2019-12-09 18:27:56 +00:00
LttPClient: warn when connection is not made to SNI
2021-11-03 18:58:40 +00:00
async def verify_snes_app(socket):
AppVersion_Request = {
"Opcode": "AppVersion",
}
await socket.send(dumps(AppVersion_Request))
app: str = loads(await socket.recv())["Results"][0]
Post-Merge Cleanup #2
2021-11-12 13:58:48 +00:00
if "SNI" not in app:
LttPClient: warn when connection is not made to SNI
2021-11-03 18:58:40 +00:00
snes_logger.warning(f"Warning: Did not find SNI as the endpoint, instead {app} was found.")
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
async def snes_connect(ctx: Context, address, deviceIndex=-1):
Delay consecutive reconnects
2020-09-01 19:45:01 +00:00
global SNES_RECONNECT_DELAY
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
if ctx.snes_socket is not None and ctx.snes_state == SNESState.SNES_CONNECTED:
some post unification cleanup.
2021-07-30 23:40:27 +00:00
if ctx.rom:
snes_logger.error('Already connected to SNES, with rom loaded.')
else:
snes_logger.error('Already connected to SNI, likely awaiting a device.')
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
return
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
device = None
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
recv_task = None
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
ctx.snes_state = SNESState.SNES_CONNECTING
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
socket = await _snes_connect(ctx, address)
ctx.snes_socket = socket
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
ctx.snes_state = SNESState.SNES_CONNECTED
move some client functions into their own functions also break some stuff while I'm at it, so don't use this yet.
2020-06-06 21:46:28 +00:00
try:
devices = await get_snes_devices(ctx)
SNIClient: provide example full connect command when required and some pep8 (#330)
2022-03-22 18:13:04 +00:00
device_count = len(devices)
multiworld
2019-12-09 18:27:56 +00:00
SNIClient: provide example full connect command when required and some pep8 (#330)
2022-03-22 18:13:04 +00:00
if device_count == 1:
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
device = devices[0]
elif ctx.snes_reconnect_address:
if ctx.snes_attached_device[1] in devices:
device = ctx.snes_attached_device[1]
else:
device = devices[ctx.snes_attached_device[0]]
SNIClient: provide example full connect command when required and some pep8 (#330)
2022-03-22 18:13:04 +00:00
elif device_count > 1:
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
if deviceIndex == -1:
SNIClient: provide example full connect command when required and some pep8 (#330)
2022-03-22 18:13:04 +00:00
snes_logger.info(f"Found {device_count} SNES devices. "
f"Connect to one with /snes <address> <device number>. For example /snes {address} 1")
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
for idx, availableDevice in enumerate(devices):
fix argument, logger name
2021-08-29 02:47:19 +00:00
snes_logger.info(str(idx + 1) + ": " + availableDevice)
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
SNIClient: provide example full connect command when required and some pep8 (#330)
2022-03-22 18:13:04 +00:00
elif (deviceIndex < 0) or (deviceIndex - 1) > device_count:
fix argument, logger name
2021-08-29 02:47:19 +00:00
snes_logger.warning("SNES device number out of range")
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
else:
device = devices[deviceIndex - 1]
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
list connected SNESes if more than one; allow connecting to specific one
2021-08-29 02:20:45 +00:00
if device is None:
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
await snes_disconnect(ctx)
return
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.info("Attaching to " + device)
multiworld
2019-12-09 18:27:56 +00:00
Attach_Request = {
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
"Opcode": "Attach",
"Space": "SNES",
"Operands": [device]
multiworld
2019-12-09 18:27:56 +00:00
}
squashed commit of many breaking changes Dropping Support for Python 3.7; adding support for Python 3.9
2020-10-19 06:26:31 +00:00
await ctx.snes_socket.send(dumps(Attach_Request))
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
ctx.snes_state = SNESState.SNES_ATTACHED
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
ctx.snes_attached_device = (devices.index(device), device)
ctx.snes_reconnect_address = address
multiworld
2019-12-09 18:27:56 +00:00
recv_task = asyncio.create_task(snes_recv_loop(ctx))
except Exception as e:
if recv_task is not None:
if not ctx.snes_socket.closed:
await ctx.snes_socket.close()
else:
if ctx.snes_socket is not None:
if not ctx.snes_socket.closed:
await ctx.snes_socket.close()
ctx.snes_socket = None
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
ctx.snes_state = SNESState.SNES_DISCONNECTED
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
if not ctx.snes_reconnect_address:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.error("Error connecting to snes (%s)" % e)
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
else:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.error(f"Error connecting to snes, attempt again in {SNES_RECONNECT_DELAY}s")
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
asyncio.create_task(snes_autoreconnect(ctx))
Delay consecutive reconnects
2020-09-01 19:45:01 +00:00
SNES_RECONNECT_DELAY *= 2
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
SNIClient: provide example full connect command when required and some pep8 (#330)
2022-03-22 18:13:04 +00:00
else:
SNES_RECONNECT_DELAY = ctx.starting_reconnect_delay
snes_logger.info(f"Attached to {device}")
move to promp_toolkit
2020-03-13 02:53:20 +00:00
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
async def snes_disconnect(ctx: Context):
if ctx.snes_socket:
if not ctx.snes_socket.closed:
await ctx.snes_socket.close()
ctx.snes_socket = None
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
async def snes_autoreconnect(ctx: Context):
Delay consecutive reconnects
2020-09-01 19:45:01 +00:00
await asyncio.sleep(SNES_RECONNECT_DELAY)
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
if ctx.snes_reconnect_address and ctx.snes_socket is None:
await snes_connect(ctx, ctx.snes_reconnect_address)
multiworld
2019-12-09 18:27:56 +00:00
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
async def snes_recv_loop(ctx: Context):
multiworld
2019-12-09 18:27:56 +00:00
try:
async for msg in ctx.snes_socket:
ctx.snes_recv_queue.put_nowait(msg)
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.warning("Snes disconnected")
multiworld
2019-12-09 18:27:56 +00:00
except Exception as e:
Multi client/server: log fewer exceptions
2019-12-16 17:39:00 +00:00
if not isinstance(e, websockets.WebSocketException):
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.exception(e)
snes_logger.error("Lost connection to the snes, type /snes to reconnect")
multiworld
2019-12-09 18:27:56 +00:00
finally:
socket, ctx.snes_socket = ctx.snes_socket, None
if socket is not None and not socket.closed:
await socket.close()
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
ctx.snes_state = SNESState.SNES_DISCONNECTED
multiworld
2019-12-09 18:27:56 +00:00
ctx.snes_recv_queue = asyncio.Queue()
ctx.hud_message_queue = []
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
ctx.rom = None
multiworld
2019-12-09 18:27:56 +00:00
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
if ctx.snes_reconnect_address:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.info(f"...reconnecting in {SNES_RECONNECT_DELAY}s")
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
asyncio.create_task(snes_autoreconnect(ctx))
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
async def snes_read(ctx: Context, address, size):
multiworld
2019-12-09 18:27:56 +00:00
try:
await ctx.snes_request_lock.acquire()
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
if ctx.snes_state != SNESState.SNES_ATTACHED or ctx.snes_socket is None or not ctx.snes_socket.open or ctx.snes_socket.closed:
multiworld
2019-12-09 18:27:56 +00:00
return None
GetAddress_Request = {
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
"Opcode": "GetAddress",
"Space": "SNES",
"Operands": [hex(address)[2:], hex(size)[2:]]
multiworld
2019-12-09 18:27:56 +00:00
}
try:
squashed commit of many breaking changes Dropping Support for Python 3.7; adding support for Python 3.9
2020-10-19 06:26:31 +00:00
await ctx.snes_socket.send(dumps(GetAddress_Request))
multiworld
2019-12-09 18:27:56 +00:00
except websockets.ConnectionClosed:
return None
data = bytes()
while len(data) < size:
try:
data += await asyncio.wait_for(ctx.snes_recv_queue.get(), 5)
except asyncio.TimeoutError:
break
if len(data) != size:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.error('Error reading %s, requested %d bytes, received %d' % (hex(address), size, len(data)))
multiworld
2019-12-09 18:27:56 +00:00
if len(data):
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.error(str(data))
snes_logger.warning('Communication Failure with SNI')
multiworld
2019-12-09 18:27:56 +00:00
if ctx.snes_socket is not None and not ctx.snes_socket.closed:
await ctx.snes_socket.close()
return None
return data
finally:
ctx.snes_request_lock.release()
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
async def snes_write(ctx: Context, write_list):
multiworld
2019-12-09 18:27:56 +00:00
try:
await ctx.snes_request_lock.acquire()
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
if ctx.snes_state != SNESState.SNES_ATTACHED or ctx.snes_socket is None or \
not ctx.snes_socket.open or ctx.snes_socket.closed:
multiworld
2019-12-09 18:27:56 +00:00
return False
Allow qusb2snes to configure itself (now that it has a menu on first run) and bind to port 23070
2020-11-11 11:36:02 +00:00
PutAddress_Request = {"Opcode": "PutAddress", "Operands": [], 'Space': 'SNES'}
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
try:
multiworld
2019-12-09 18:27:56 +00:00
for address, data in write_list:
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
PutAddress_Request['Operands'] = [hex(address)[2:], hex(len(data))[2:]]
multiworld
2019-12-09 18:27:56 +00:00
if ctx.snes_socket is not None:
squashed commit of many breaking changes Dropping Support for Python 3.7; adding support for Python 3.9
2020-10-19 06:26:31 +00:00
await ctx.snes_socket.send(dumps(PutAddress_Request))
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
await ctx.snes_socket.send(data)
warn when data could not be sent to snes
2020-12-01 20:57:18 +00:00
else:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.warning(f"Could not send data to SNES: {data}")
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
except websockets.ConnectionClosed:
return False
multiworld
2019-12-09 18:27:56 +00:00
return True
finally:
ctx.snes_request_lock.release()
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
def snes_buffered_write(ctx: Context, address, data):
warn when data could not be sent to snes
2020-12-01 20:57:18 +00:00
if ctx.snes_write_buffer and (ctx.snes_write_buffer[-1][0] + len(ctx.snes_write_buffer[-1][1])) == address:
# append to existing write command, bundling them
multiworld
2019-12-09 18:27:56 +00:00
ctx.snes_write_buffer[-1] = (ctx.snes_write_buffer[-1][0], ctx.snes_write_buffer[-1][1] + data)
else:
ctx.snes_write_buffer.append((address, data))
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
async def snes_flush_writes(ctx: Context):
multiworld
2019-12-09 18:27:56 +00:00
if not ctx.snes_write_buffer:
return
warn when data could not be sent to snes
2020-12-01 20:57:18 +00:00
# swap buffers
ctx.snes_write_buffer, writes = [], ctx.snes_write_buffer
await snes_write(ctx, writes)
multiworld
2019-12-09 18:27:56 +00:00
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
async def track_locations(ctx: Context, roomid, roomdata):
multiworld
2019-12-09 18:27:56 +00:00
new_locations = []
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
def new_check(location_id):
new_locations.append(location_id)
ctx.locations_checked.add(location_id)
location = ctx.location_name_getter(location_id)
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
snes_logger.info(
f'New Check: {location} ({len(ctx.locations_checked)}/{len(ctx.missing_locations) + len(ctx.checked_locations)})')
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
Merge branch 'main' into multishop # Conflicts: # MultiClient.py
2021-01-20 02:17:08 +00:00
try:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
shop_data = await snes_read(ctx, SHOP_ADDR, SHOP_LEN)
shop_data_changed = False
shop_data = list(shop_data)
for cnt, b in enumerate(shop_data):
location = Shops.SHOP_ID_START + cnt
if int(b) and location not in ctx.locations_checked:
new_check(location)
LttP: Add Allow collect option, default Off. (#414) * LttP: Add Allow collect option, default Off. * Add allow_collect to the sample yaml.
2022-04-05 01:54:49 +00:00
if ctx.allow_collect and location in ctx.checked_locations and location not in ctx.locations_checked \
Clients: change scouted locations_info to full NetworkItem (#324)
2022-03-21 14:26:38 +00:00
and location in ctx.locations_info and ctx.locations_info[location].player != ctx.slot:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
if not int(b):
shop_data[cnt] += 1
shop_data_changed = True
if shop_data_changed:
snes_buffered_write(ctx, SHOP_ADDR, bytes(shop_data))
Fixes to clients/servers for shop checks
2020-12-15 08:34:22 +00:00
except Exception as e:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.info(f"Exception: {e}")
Merge branch 'main' into multishop # Conflicts: # MultiClient.py
2021-01-20 02:17:08 +00:00
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
for location_id, (loc_roomid, loc_mask) in location_table_uw_id.items():
Make multiclient/multiserver/tracker keydropshuffle aware
2020-10-27 07:47:59 +00:00
try:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
if location_id not in ctx.locations_checked and loc_roomid == roomid and \
(roomdata << 4) & loc_mask != 0:
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
new_check(location_id)
Make multiclient/multiserver/tracker keydropshuffle aware
2020-10-27 07:47:59 +00:00
except Exception as e:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.exception(f"Exception: {e}")
multiworld
2019-12-09 18:27:56 +00:00
uw_begin = 0x129
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
ow_end = uw_end = 0
multiworld
2019-12-09 18:27:56 +00:00
uw_unchecked = {}
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
uw_checked = {}
multiworld
2019-12-09 18:27:56 +00:00
for location, (roomid, mask) in location_table_uw.items():
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
location_id = Regions.lookup_name_to_id[location]
if location_id not in ctx.locations_checked:
uw_unchecked[location_id] = (roomid, mask)
multiworld
2019-12-09 18:27:56 +00:00
uw_begin = min(uw_begin, roomid)
uw_end = max(uw_end, roomid + 1)
LttP: Add Allow collect option, default Off. (#414) * LttP: Add Allow collect option, default Off. * Add allow_collect to the sample yaml.
2022-04-05 01:54:49 +00:00
if ctx.allow_collect and location_id not in boss_locations and location_id in ctx.checked_locations \
and location_id not in ctx.locations_checked and location_id in ctx.locations_info \
and ctx.locations_info[location_id].player != ctx.slot:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
uw_begin = min(uw_begin, roomid)
uw_end = max(uw_end, roomid + 1)
uw_checked[location_id] = (roomid, mask)
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
multiworld
2019-12-09 18:27:56 +00:00
if uw_begin < uw_end:
uw_data = await snes_read(ctx, SAVEDATA_START + (uw_begin * 2), (uw_end - uw_begin) * 2)
if uw_data is not None:
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
for location_id, (roomid, mask) in uw_unchecked.items():
multiworld
2019-12-09 18:27:56 +00:00
offset = (roomid - uw_begin) * 2
roomdata = uw_data[offset] | (uw_data[offset + 1] << 8)
if roomdata & mask != 0:
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
new_check(location_id)
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
if uw_checked:
uw_data = list(uw_data)
for location_id, (roomid, mask) in uw_checked.items():
offset = (roomid - uw_begin) * 2
roomdata = uw_data[offset] | (uw_data[offset + 1] << 8)
roomdata |= mask
uw_data[offset] = roomdata & 0xFF
uw_data[offset + 1] = roomdata >> 8
snes_buffered_write(ctx, SAVEDATA_START + (uw_begin * 2), bytes(uw_data))
multiworld
2019-12-09 18:27:56 +00:00
ow_begin = 0x82
ow_unchecked = {}
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
ow_checked = {}
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
for location_id, screenid in location_table_ow_id.items():
if location_id not in ctx.locations_checked:
ow_unchecked[location_id] = screenid
multiworld
2019-12-09 18:27:56 +00:00
ow_begin = min(ow_begin, screenid)
ow_end = max(ow_end, screenid + 1)
LttP: Add Allow collect option, default Off. (#414) * LttP: Add Allow collect option, default Off. * Add allow_collect to the sample yaml.
2022-04-05 01:54:49 +00:00
if ctx.allow_collect and location_id in ctx.checked_locations and location_id in ctx.locations_info \
Clients: change scouted locations_info to full NetworkItem (#324)
2022-03-21 14:26:38 +00:00
and ctx.locations_info[location_id].player != ctx.slot:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
ow_checked[location_id] = screenid
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
multiworld
2019-12-09 18:27:56 +00:00
if ow_begin < ow_end:
ow_data = await snes_read(ctx, SAVEDATA_START + 0x280 + ow_begin, ow_end - ow_begin)
if ow_data is not None:
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
for location_id, screenid in ow_unchecked.items():
multiworld
2019-12-09 18:27:56 +00:00
if ow_data[screenid - ow_begin] & 0x40 != 0:
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
new_check(location_id)
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
if ow_checked:
ow_data = list(ow_data)
for location_id, screenid in ow_checked.items():
ow_data[screenid - ow_begin] |= 0x40
snes_buffered_write(ctx, SAVEDATA_START + 0x280 + ow_begin, bytes(ow_data))
multiworld
2019-12-09 18:27:56 +00:00
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
if not ctx.locations_checked.issuperset(location_table_npc_id):
multiworld
2019-12-09 18:27:56 +00:00
npc_data = await snes_read(ctx, SAVEDATA_START + 0x410, 2)
if npc_data is not None:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
npc_value_changed = False
multiworld
2019-12-09 18:27:56 +00:00
npc_value = npc_data[0] | (npc_data[1] << 8)
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
for location_id, mask in location_table_npc_id.items():
if npc_value & mask != 0 and location_id not in ctx.locations_checked:
new_check(location_id)
LttP: Add Allow collect option, default Off. (#414) * LttP: Add Allow collect option, default Off. * Add allow_collect to the sample yaml.
2022-04-05 01:54:49 +00:00
if ctx.allow_collect and location_id in ctx.checked_locations and location_id not in ctx.locations_checked \
Clients: change scouted locations_info to full NetworkItem (#324)
2022-03-21 14:26:38 +00:00
and location_id in ctx.locations_info and ctx.locations_info[location_id].player != ctx.slot:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
npc_value |= mask
npc_value_changed = True
if npc_value_changed:
npc_data = bytes([npc_value & 0xFF, npc_value >> 8])
snes_buffered_write(ctx, SAVEDATA_START + 0x410, npc_data)
multiworld
2019-12-09 18:27:56 +00:00
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
if not ctx.locations_checked.issuperset(location_table_misc_id):
multiworld
2019-12-09 18:27:56 +00:00
misc_data = await snes_read(ctx, SAVEDATA_START + 0x3c6, 4)
if misc_data is not None:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
misc_data = list(misc_data)
misc_data_changed = False
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
for location_id, (offset, mask) in location_table_misc_id.items():
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
assert (0x3c6 <= offset <= 0x3c9)
Client now uses location_id consistently internally, instead of switching on a dime all the time And some smaller changes
2021-03-07 21:05:07 +00:00
if misc_data[offset - 0x3c6] & mask != 0 and location_id not in ctx.locations_checked:
new_check(location_id)
LttP: Add Allow collect option, default Off. (#414) * LttP: Add Allow collect option, default Off. * Add allow_collect to the sample yaml.
2022-04-05 01:54:49 +00:00
if ctx.allow_collect and location_id in ctx.checked_locations and location_id not in ctx.locations_checked \
Clients: change scouted locations_info to full NetworkItem (#324)
2022-03-21 14:26:38 +00:00
and location_id in ctx.locations_info and ctx.locations_info[location_id].player != ctx.slot:
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
misc_data_changed = True
misc_data[offset - 0x3c6] |= mask
if misc_data_changed:
snes_buffered_write(ctx, SAVEDATA_START + 0x3c6, bytes(misc_data))
multiworld
2019-12-09 18:27:56 +00:00
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
if new_locations:
attach command to args dict
2021-02-21 22:46:05 +00:00
await ctx.send_msgs([{"cmd": 'LocationChecks', "locations": new_locations}])
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
await snes_flush_writes(ctx)
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
multiworld
2019-12-09 18:27:56 +00:00
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
async def game_watcher(ctx: Context):
Changes * Game end detection - Detect if the player finished their game, and announce it accordingly. * Add a client side /slow_mode option. (allows to delay receiving items when a massive amount of them come in, like from a forfeit.)
2020-04-25 03:07:28 +00:00
prev_game_timer = 0
perf_counter = time.perf_counter()
multiworld
2019-12-09 18:27:56 +00:00
while not ctx.exit_event.is_set():
MultiClient: signal an event when receiving item data to improve responsiveness
2020-01-18 10:28:08 +00:00
try:
Changes * Game end detection - Detect if the player finished their game, and announce it accordingly. * Add a client side /slow_mode option. (allows to delay receiving items when a massive amount of them come in, like from a forfeit.)
2020-04-25 03:07:28 +00:00
await asyncio.wait_for(ctx.watcher_event.wait(), 0.125)
MultiClient: signal an event when receiving item data to improve responsiveness
2020-01-18 10:28:08 +00:00
except asyncio.TimeoutError:
pass
ctx.watcher_event.clear()
multiworld
2019-12-09 18:27:56 +00:00
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
if not ctx.rom:
Changes * Game end detection - Detect if the player finished their game, and announce it accordingly. * Add a client side /slow_mode option. (allows to delay receiving items when a massive amount of them come in, like from a forfeit.)
2020-04-25 03:07:28 +00:00
ctx.finished_game = False
SM update (#147) * fixed generations failing when only bosses are unreachable * - replaced setting maxDiff to infinity with a bool only affecting boss logics if only bosses are left to finish * fixed failling generations when using 'fun' settings Accessibility checks are forced to 'items' if restricted locations are used by VARIA following usage of 'fun' settings * fixed debug logger * removed unsupported "suits_restriction" option * fixed generations failing when only bosses are unreachable (using a less intrusive approach for AP) * - fixed deathlink emptying reserves - added death_link_survive option that lets player survive when receiving a deathlink if the have non-empty reserves * - merged death_link and death_link_survive options
2021-12-02 05:11:42 +00:00
ctx.death_link_allow_survive = False
[SM] remote item back compat fix (#400)
2022-04-02 23:36:31 +00:00
game_name = await snes_read(ctx, SM_ROMNAME_START, 5)
MultiServer: fix IncompatibleVersion not triggering
2021-11-22 19:32:59 +00:00
if game_name is None:
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
continue
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
elif game_name[:2] == b"SM":
Post-Merge Cleanup
2021-11-12 13:36:34 +00:00
ctx.game = GAME_SM
[SM] remote item back compat fix (#400)
2022-04-02 23:36:31 +00:00
# versions lower than 0.3.0 dont have item handling flag nor remote item support
romVersion = int(game_name[2:5].decode('UTF-8'))
if romVersion < 30:
ctx.items_handling = 0b001 # full local
else:
item_handling = await snes_read(ctx, SM_REMOTE_ITEM_FLAG_ADDR, 1)
ctx.items_handling = 0b001 if item_handling is None else item_handling[0]
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
else:
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
game_name = await snes_read(ctx, SMZ3_ROMNAME_START, 3)
if game_name == b"ZSM":
ctx.game = GAME_SMZ3
ctx.items_handling = 0b101 # local items and remote start inventory
else:
ctx.game = GAME_ALTTP
ctx.items_handling = 0b001 # full local
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
rom = await snes_read(ctx, SM_ROMNAME_START if ctx.game == GAME_SM else SMZ3_ROMNAME_START if ctx.game == GAME_SMZ3 else ROMNAME_START, ROMNAME_SIZE)
multiworld
2019-12-09 18:27:56 +00:00
if rom is None or rom == bytes([0] * ROMNAME_SIZE):
continue
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
squashed commit of many breaking changes Dropping Support for Python 3.7; adding support for Python 3.9
2020-10-19 06:26:31 +00:00
ctx.rom = rom
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
if ctx.game != GAME_SMZ3:
death_link = await snes_read(ctx, DEATH_LINK_ACTIVE_ADDR if ctx.game == GAME_ALTTP else
SM_DEATH_LINK_ACTIVE_ADDR, 1)
if death_link:
LttP: Add Allow collect option, default Off. (#414) * LttP: Add Allow collect option, default Off. * Add allow_collect to the sample yaml.
2022-04-05 01:54:49 +00:00
ctx.allow_collect = bool(death_link[0] & 0b100)
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
ctx.death_link_allow_survive = bool(death_link[0] & 0b10)
await ctx.update_death_link(bool(death_link[0] & 0b1))
Don't clear locally visited locations if rom is same as previous on /snes after /snes_close (#98)
2020-06-02 14:38:23 +00:00
if not ctx.prev_rom or ctx.prev_rom != ctx.rom:
ctx.locations_checked = set()
ctx.locations_scouted = set()
Mark LttP items as collected in game if item is not owned by player.
2022-03-07 22:10:07 +00:00
ctx.locations_info = {}
update rom name handling
2020-07-14 02:48:56 +00:00
ctx.prev_rom = ctx.rom
Don't clear locally visited locations if rom is same as previous on /snes after /snes_close (#98)
2020-06-02 14:38:23 +00:00
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
if ctx.awaiting_rom:
Factorio integration
2021-04-01 09:40:58 +00:00
await ctx.server_auth(False)
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
if ctx.auth and ctx.auth != ctx.rom:
unify clients and setup
2021-07-30 22:03:48 +00:00
snes_logger.warning("ROM change detected, please reconnect to the multiworld server")
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
await ctx.disconnect()
multiworld
2019-12-09 18:27:56 +00:00
Post-Merge Cleanup
2021-11-12 13:36:34 +00:00
if ctx.game == GAME_ALTTP:
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
gamemode = await snes_read(ctx, WRAM_START + 0x10, 1)
if "DeathLink" in ctx.tags and gamemode and ctx.last_death_link + 1 < time.time():
currently_dead = gamemode[0] in DEATH_MODES
Fix error in SNIClient
2021-11-12 14:48:23 +00:00
await ctx.handle_deathlink_state(currently_dead)
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
gameend = await snes_read(ctx, SAVEDATA_START + 0x443, 1)
game_timer = await snes_read(ctx, SAVEDATA_START + 0x42E, 4)
if gamemode is None or gameend is None or game_timer is None or \
(gamemode[0] not in INGAME_MODES and gamemode[0] not in ENDGAME_MODES):
Changes * Game end detection - Detect if the player finished their game, and announce it accordingly. * Add a client side /slow_mode option. (allows to delay receiving items when a massive amount of them come in, like from a forfeit.)
2020-04-25 03:07:28 +00:00
continue
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
delay = 7 if ctx.slow_mode else 2
if gameend[0]:
if not ctx.finished_game:
await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
ctx.finished_game = True
if time.perf_counter() - perf_counter < delay:
continue
else:
perf_counter = time.perf_counter()
Changes * Game end detection - Detect if the player finished their game, and announce it accordingly. * Add a client side /slow_mode option. (allows to delay receiving items when a massive amount of them come in, like from a forfeit.)
2020-04-25 03:07:28 +00:00
else:
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
game_timer = game_timer[0] | (game_timer[1] << 8) | (game_timer[2] << 16) | (game_timer[3] << 24)
if abs(game_timer - prev_game_timer) < (delay * 60):
continue
else:
prev_game_timer = game_timer
if gamemode in ENDGAME_MODES: # triforce room and credits
Changes * Game end detection - Detect if the player finished their game, and announce it accordingly. * Add a client side /slow_mode option. (allows to delay receiving items when a massive amount of them come in, like from a forfeit.)
2020-04-25 03:07:28 +00:00
continue
multiworld
2019-12-09 18:27:56 +00:00
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
data = await snes_read(ctx, RECV_PROGRESS_ADDR, 8)
if data is None:
continue
recv_index = data[0] | (data[1] << 8)
recv_item = data[2]
roomid = data[4] | (data[5] << 8)
roomdata = data[6]
scout_location = data[7]
if recv_index < len(ctx.items_received) and recv_item == 0:
item = ctx.items_received[recv_index]
recv_index += 1
logging.info('Received %s from %s (%s) (%d/%d in list)' % (
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
color(ctx.item_name_getter(item.item), 'red', 'bold'),
color(ctx.player_names[item.player], 'yellow'),
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
ctx.location_name_getter(item.location), recv_index, len(ctx.items_received)))
snes_buffered_write(ctx, RECV_PROGRESS_ADDR,
bytes([recv_index & 0xFF, (recv_index >> 8) & 0xFF]))
snes_buffered_write(ctx, RECV_ITEM_ADDR,
bytes([item.item]))
snes_buffered_write(ctx, RECV_ITEM_PLAYER_ADDR,
bytes([min(ROM_PLAYER_LIMIT, item.player) if item.player != ctx.slot else 0]))
if scout_location > 0 and scout_location in ctx.locations_info:
snes_buffered_write(ctx, SCOUTREPLY_LOCATION_ADDR,
bytes([scout_location]))
snes_buffered_write(ctx, SCOUTREPLY_ITEM_ADDR,
Clients: change scouted locations_info to full NetworkItem (#324)
2022-03-21 14:26:38 +00:00
bytes([ctx.locations_info[scout_location].item]))
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
snes_buffered_write(ctx, SCOUTREPLY_PLAYER_ADDR,
Clients: change scouted locations_info to full NetworkItem (#324)
2022-03-21 14:26:38 +00:00
bytes([min(ROM_PLAYER_LIMIT, ctx.locations_info[scout_location].player)]))
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
await snes_flush_writes(ctx)
if scout_location > 0 and scout_location not in ctx.locations_scouted:
ctx.locations_scouted.add(scout_location)
await ctx.send_msgs([{"cmd": "LocationScouts", "locations": [scout_location]}])
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
await track_locations(ctx, roomid, roomdata)
Post-Merge Cleanup
2021-11-12 13:36:34 +00:00
elif ctx.game == GAME_SM:
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
gamemode = await snes_read(ctx, WRAM_START + 0x0998, 1)
if "DeathLink" in ctx.tags and gamemode and ctx.last_death_link + 1 < time.time():
currently_dead = gamemode[0] in SM_DEATH_MODES
Fix error in SNIClient
2021-11-12 14:48:23 +00:00
await ctx.handle_deathlink_state(currently_dead)
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
if gamemode is not None and gamemode[0] in SM_ENDGAME_MODES:
if not ctx.finished_game:
await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
ctx.finished_game = True
continue
data = await snes_read(ctx, SM_RECV_PROGRESS_ADDR + 0x680, 4)
if data is None:
continue
recv_index = data[0] | (data[1] << 8)
recv_item = data[2] | (data[3] << 8)
while (recv_index < recv_item):
itemAdress = recv_index * 8
message = await snes_read(ctx, SM_RECV_PROGRESS_ADDR + 0x700 + itemAdress, 8)
Post-Merge Cleanup #2
2021-11-12 13:58:48 +00:00
# worldId = message[0] | (message[1] << 8) # unused
# itemId = message[2] | (message[3] << 8) # unused
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
itemIndex = (message[4] | (message[5] << 8)) >> 3
recv_index += 1
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
snes_buffered_write(ctx, SM_RECV_PROGRESS_ADDR + 0x680,
bytes([recv_index & 0xFF, (recv_index >> 8) & 0xFF]))
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
from worlds.sm.Locations import locations_start_id
location_id = locations_start_id + itemIndex
ctx.locations_checked.add(location_id)
location = ctx.location_name_getter(location_id)
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
snes_logger.info(
f'New Check: {location} ({len(ctx.locations_checked)}/{len(ctx.missing_locations) + len(ctx.checked_locations)})')
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
await ctx.send_msgs([{"cmd": 'LocationChecks', "locations": [location_id]}])
data = await snes_read(ctx, SM_RECV_PROGRESS_ADDR + 0x600, 4)
if data is None:
continue
Post-Merge Cleanup #2
2021-11-12 13:58:48 +00:00
# recv_itemOutPtr = data[0] | (data[1] << 8) # unused
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
itemOutPtr = data[2] | (data[3] << 8)
multiworld
2019-12-09 18:27:56 +00:00
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
from worlds.sm.Items import items_start_id
[SM] Add support for Remote Items (#317)
2022-03-21 04:34:47 +00:00
from worlds.sm.Locations import locations_start_id
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
if itemOutPtr < len(ctx.items_received):
item = ctx.items_received[itemOutPtr]
itemId = item.item - items_start_id
[SM] remote item back compat fix (#400)
2022-04-02 23:36:31 +00:00
locationId = (item.location - locations_start_id) if item.location >= 0 and bool(ctx.items_handling & 0b010) else 0x00
MultiClient: signal an event when receiving item data to improve responsiveness
2020-01-18 10:28:08 +00:00
[SM] added support for more than 255 players (will print Archipelago for higher player number) (#130) * added support for more than 255 players (will print Archipelago for higher player number)
2021-11-13 14:40:20 +00:00
playerID = item.player if item.player <= SM_ROM_PLAYER_LIMIT else 0
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
snes_buffered_write(ctx, SM_RECV_PROGRESS_ADDR + itemOutPtr * 4, bytes(
[SM] Add support for Remote Items (#317)
2022-03-21 04:34:47 +00:00
[playerID & 0xFF, (playerID >> 8) & 0xFF, itemId & 0xFF, locationId & 0xFF]))
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
itemOutPtr += 1
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
snes_buffered_write(ctx, SM_RECV_PROGRESS_ADDR + 0x602,
bytes([itemOutPtr & 0xFF, (itemOutPtr >> 8) & 0xFF]))
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
logging.info('Received %s from %s (%s) (%d/%d in list)' % (
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
color(ctx.item_name_getter(item.item), 'red', 'bold'),
color(ctx.player_names[item.player], 'yellow'),
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
ctx.location_name_getter(item.location), itemOutPtr, len(ctx.items_received)))
await snes_flush_writes(ctx)
Add SMZ3 support (#270)
2022-03-15 12:55:57 +00:00
elif ctx.game == GAME_SMZ3:
currentGame = await snes_read(ctx, SRAM_START + 0x33FE, 2)
if (currentGame is not None):
if (currentGame[0] != 0):
gamemode = await snes_read(ctx, WRAM_START + 0x0998, 1)
endGameModes = SM_ENDGAME_MODES
else:
gamemode = await snes_read(ctx, WRAM_START + 0x10, 1)
endGameModes = ENDGAME_MODES
if gamemode is not None and (gamemode[0] in endGameModes):
if not ctx.finished_game:
await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
ctx.finished_game = True
continue
data = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + 0x680, 4)
if data is None:
continue
recv_index = data[0] | (data[1] << 8)
recv_item = data[2] | (data[3] << 8)
while (recv_index < recv_item):
itemAdress = recv_index * 8
message = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + 0x700 + itemAdress, 8)
# worldId = message[0] | (message[1] << 8) # unused
# itemId = message[2] | (message[3] << 8) # unused
isZ3Item = ((message[5] & 0x80) != 0)
maskedPart = (message[5] & 0x7F) if isZ3Item else message[5]
itemIndex = ((message[4] | (maskedPart << 8)) >> 3) + (256 if isZ3Item else 0)
recv_index += 1
snes_buffered_write(ctx, SMZ3_RECV_PROGRESS_ADDR + 0x680, bytes([recv_index & 0xFF, (recv_index >> 8) & 0xFF]))
from worlds.smz3.TotalSMZ3.Location import locations_start_id
location_id = locations_start_id + itemIndex
ctx.locations_checked.add(location_id)
location = ctx.location_name_getter(location_id)
snes_logger.info(f'New Check: {location} ({len(ctx.locations_checked)}/{len(ctx.missing_locations) + len(ctx.checked_locations)})')
await ctx.send_msgs([{"cmd": 'LocationChecks', "locations": [location_id]}])
data = await snes_read(ctx, SMZ3_RECV_PROGRESS_ADDR + 0x600, 4)
if data is None:
continue
# recv_itemOutPtr = data[0] | (data[1] << 8) # unused
itemOutPtr = data[2] | (data[3] << 8)
from worlds.smz3.TotalSMZ3.Item import items_start_id
if itemOutPtr < len(ctx.items_received):
item = ctx.items_received[itemOutPtr]
itemId = item.item - items_start_id
playerID = item.player if item.player <= SMZ3_ROM_PLAYER_LIMIT else 0
snes_buffered_write(ctx, SMZ3_RECV_PROGRESS_ADDR + itemOutPtr * 4, bytes([playerID & 0xFF, (playerID >> 8) & 0xFF, itemId & 0xFF, (itemId >> 8) & 0xFF]))
itemOutPtr += 1
snes_buffered_write(ctx, SMZ3_RECV_PROGRESS_ADDR + 0x602, bytes([itemOutPtr & 0xFF, (itemOutPtr >> 8) & 0xFF]))
logging.info('Received %s from %s (%s) (%d/%d in list)' % (
color(ctx.item_name_getter(item.item), 'red', 'bold'), color(ctx.player_names[item.player], 'yellow'),
ctx.location_name_getter(item.location), itemOutPtr, len(ctx.items_received)))
await snes_flush_writes(ctx)
performance improvements and small adjustments
2020-03-09 23:38:29 +00:00
Clients: compatibility change for old Intel graphics.
2021-12-10 08:29:59 +00:00
performance improvements and small adjustments
2020-03-09 23:38:29 +00:00
async def run_game(romfile):
Factorio integration
2021-04-01 09:40:58 +00:00
auto_start = Utils.get_options()["lttp_options"].get("rom_start", True)
expand rom auto_start to be customizable
2020-07-15 15:19:16 +00:00
if auto_start is True:
import webbrowser
webbrowser.open(romfile)
elif os.path.isfile(auto_start):
subprocess.Popen([auto_start, romfile],
stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
performance improvements and small adjustments
2020-03-09 23:38:29 +00:00
LttP: Implement DeathLink
2021-11-01 18:37:47 +00:00
multiworld
2019-12-09 18:27:56 +00:00
async def main():
WebUI (#100) * Object-Oriented base changes for web-ui prep * remove debug raise * optimize broadcast to serialize once * Implement WebUI socket, static assets, and classes - Still need to wrap logging functions and send output to UI - UI commands are successfully being sent to the server * GUI operational. Wrap logging functions, implement server address selection on GUI, automatically launch web browser when client websocket is served * Update MultiServer status when a user disconnects / reconnects * Implement colored item and hint checks, improve GUI readability * Fix improper formatting on received items * Update SNES connection status on disconnect / reconnect. Implement itemFound, prevent accidentally printing JS objects * Minor text change for itemFound * Fixed a very wrong comment * Fixed client commands not working, fixed un-helpful error messages appearing in GUI * Fix a bug causing a failure to connect to a multiworld server if a previously existing cached address was present and the client was loaded without an address passed in * Convert WebUI to React /w Redux. WebSocket communications not yet operational. * WebUI fully converted to React / Redux. - Websocket communication operational - Added a button to connect to the multiserver which appears only when a SNES is connected and a server connection is not active * Restore some features lost in WebUI - Restore (found) notification on hints if the item has already been obtained - Restore (x/y) indicator on received items, which indicates the number of items the client is waiting to receive from the client in a queue * Fix a grammatical UI big causing player names to show only an apostrophe when possessive * Add support for multiple SNES Devices, and switching between them * freeze support for client * make sure flask works when frozen * UI Improvements - Hint messages now actually show a found status via ✔ and ❌ emoji - Active player name is always a different color than other players (orange for now) - Add a toggle to show only entries relevant to the active player - Added a WidgetArea - Added a notes widget * Received items now marked as relevant * Include production build for deployment * Notes now survive a browser close. Minimum width applied to monitor to prevent CSS issues. * include webUi folder in setup.py * Bugfixes for Monitor - Fix a bug causing the monitor window to grow beyond it's intended content limit - Reduced monitor content limit to 200 items - Ensured each monitor entry has a unique key * Prevent eslint from yelling at me about stupid things * Add button to collapse sidebar, press enter on empty server input to disconnect on purpose * WebUI is now aware of client disconnect, message log limit increased to 350, fix !missing output * Update WebUI to v2.2.1 - Added color to WebUI for entrance-span - Make !missing show total count at bottom of list to match /missing behavior * Fix a bug causing clients version <= 2.2.0 to crash when anyone asks for a hint - Also fix a bug in the WebUI causing the entrance location to always show as "somewhere" * Update WebUI color palette (this cost me $50) * allow text console input alongside web-ui * remove Flask a bit overkill for what we're doing * remove jinja2 * Update WebUI to work with new hosting mechanism * with flask gone, we no longer need subprocess shenanigans * If multiple web ui clients try to run, at least present a working console * Update MultiClient and WebUI to handle multiple clients simultaneously. - The port on which the websocket for the WebUI is hosted is not chosen randomly from 5000 - 5999. This port is passed to the browser so it knows which MultiClient to connect to - Removed failure condition if a web server is already running, as there is no need to run more than one web server on a single system. If an exception is thrown while attempting to launch a web server, a check is made for the port being unavailable. If the port is unavailable, it probably means the user is launching a second MultiClient. A web browser is then opened with a connection to the correct webui_socket_port. - Add a /web command to the MultiClient to repoen the appropriate browser window and get params in case a user accidentally closes the tab * Use proper name for WebUI * move webui into /data with other data files * make web ui optional This is mostly for laptop users wanting to preserve some battery, should not be needed outside of that. * fix direct server start * re-add connection timer * fix indentation Co-authored-by: Chris <chris@legendserver.info>
2020-06-03 19:29:43 +00:00
multiprocessing.freeze_support()
Clients: consolidate argument parsing
2021-11-09 11:53:05 +00:00
parser = get_base_parser()
implement binary patching for multimystery (for now no gui/cli support)
2020-03-05 23:48:23 +00:00
parser.add_argument('diff_file', default="", type=str, nargs="?",
update Archipelago
2021-01-03 13:32:32 +00:00
help='Path to a Archipelago Binary Patch file')
LttP: Move over to SNI
2021-07-07 01:45:27 +00:00
parser.add_argument('--snes', default='localhost:8080', help='Address of the SNI server.')
MultiServer/Client: use logging instead of print and log time on the server
2020-01-18 11:21:57 +00:00
parser.add_argument('--loglevel', default='info', choices=['debug', 'info', 'warning', 'error', 'critical'])
multiworld
2019-12-09 18:27:56 +00:00
args = parser.parse_args()
Clients: consolidate argument parsing
2021-11-09 11:53:05 +00:00
implement binary patching for multimystery (for now no gui/cli support)
2020-03-05 23:48:23 +00:00
if args.diff_file:
import Patch
store last used adjuster settings and use them for patching might use them as gui defaults later
2020-04-26 13:14:30 +00:00
logging.info("Patch file was supplied. Creating sfc rom..")
performance improvements and small adjustments
2020-03-09 23:38:29 +00:00
meta, romfile = Patch.create_rom_file(args.diff_file)
SNIClient: fix apsoe handling
2021-12-01 00:01:41 +00:00
if "server" in meta:
args.connect = meta["server"]
performance improvements and small adjustments
2020-03-09 23:38:29 +00:00
logging.info(f"Wrote rom file to {romfile}")
SNIClient: patch and launch SoE
2021-11-14 20:14:22 +00:00
if args.diff_file.endswith(".apsoe"):
import webbrowser
SNIClient: add #server= to url for soe/wasm client
2021-12-01 00:27:51 +00:00
webbrowser.open("http://www.evermizer.com/apclient/" +
(f"#server={meta['server']}" if "server" in meta else ""))
SNIClient: patch and launch SoE
2021-11-14 20:14:22 +00:00
logging.info("Starting Evermizer Client in your Browser...")
import time
time.sleep(3)
sys.exit()
elif args.diff_file.endswith((".apbp", "apz3")):
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
adjustedromfile, adjusted = get_alttp_settings(romfile)
SNIClient: patch and launch SoE
2021-11-14 20:14:22 +00:00
asyncio.create_task(run_game(adjustedromfile if adjusted else romfile))
else:
asyncio.create_task(run_game(romfile))
MultiServer/Client: use logging instead of print and log time on the server
2020-01-18 11:21:57 +00:00
round of post-test fixes
2021-07-23 18:04:51 +00:00
ctx = Context(args.snes, args.connect, args.password)
multiworld
2019-12-09 18:27:56 +00:00
if ctx.server_task is None:
Factorio integration
2021-04-01 09:40:58 +00:00
ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
Clients: allow use of console input if stdin is available. Such as unfrozen + gui
2021-11-26 05:02:03 +00:00
input_task = None
CommonClient.py: move in gui_enabled
2021-08-20 20:31:17 +00:00
if gui_enabled:
Added Super Metroid support (#46) Varia Randomizer based implementation LttPClient -> SNIClient
2021-11-12 13:00:11 +00:00
from kvui import SNIManager
ctx.ui = SNIManager(ctx)
move ctx.ui to CommonClient.py
2021-07-30 23:53:06 +00:00
ui_task = asyncio.create_task(ctx.ui.async_run(), name="UI")
unify clients and setup
2021-07-30 22:03:48 +00:00
else:
ui_task = None
Clients: allow use of console input if stdin is available. Such as unfrozen + gui
2021-11-26 05:02:03 +00:00
if sys.stdin:
input_task = asyncio.create_task(console_loop(ctx), name="Input")
unify clients and setup
2021-07-30 22:03:48 +00:00
CommonClient: consolidate shutdown handling
2021-11-21 01:02:40 +00:00
snes_connect_task = asyncio.create_task(snes_connect(ctx, ctx.snes_address), name="SNES Connect")
Factorio integration
2021-04-01 09:40:58 +00:00
watcher_task = asyncio.create_task(game_watcher(ctx), name="GameWatcher")
multiworld
2019-12-09 18:27:56 +00:00
await ctx.exit_event.wait()
CommonClient: consolidate shutdown handling
2021-11-21 01:02:40 +00:00
Multiworld: clients will now be automatically be identified from the rom name and have their names and teams set by the host, meaning those need to be configured during seed gen Player names will show up in spoiler log and hint tiles instead of player id MultiClient: autoreconnect to mw server
2020-01-14 09:42:27 +00:00
ctx.server_address = None
MultiClient: auto reconnect to snes
2020-01-13 02:55:33 +00:00
ctx.snes_reconnect_address = None
multiworld
2019-12-09 18:27:56 +00:00
if ctx.snes_socket is not None and not ctx.snes_socket.closed:
await ctx.snes_socket.close()
CommonClient: consolidate shutdown handling
2021-11-21 01:02:40 +00:00
if snes_connect_task:
snes_connect_task.cancel()
await watcher_task
await ctx.shutdown()
multiworld
2019-12-09 18:27:56 +00:00
unify clients and setup
2021-07-30 22:03:48 +00:00
if ui_task:
await ui_task
if input_task:
input_task.cancel()
multiworld
2019-12-09 18:27:56 +00:00
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
def get_alttp_settings(romfile: str):
lastSettings = Utils.get_adjuster_settings(GAME_ALTTP)
adjusted = False
adjustedromfile = ''
if lastSettings:
choice = 'no'
if not hasattr(lastSettings, 'auto_apply') or 'ask' in lastSettings.auto_apply:
whitelist = {"music", "menuspeed", "heartbeep", "heartcolor", "ow_palettes", "quickswap",
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
"uw_palettes", "sprite", "sword_palettes", "shield_palettes", "hud_palettes",
LttP: Add Allow collect option, default Off. (#414) * LttP: Add Allow collect option, default Off. * Add allow_collect to the sample yaml.
2022-04-05 01:54:49 +00:00
"reduceflashing", "deathlink", "allowcollect"}
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
printed_options = {name: value for name, value in vars(lastSettings).items() if name in whitelist}
if hasattr(lastSettings, "sprite_pool"):
sprite_pool = {}
for sprite in lastSettings.sprite_pool:
if sprite in sprite_pool:
sprite_pool[sprite] += 1
else:
sprite_pool[sprite] = 1
if sprite_pool:
printed_options["sprite_pool"] = sprite_pool
import pprint
if gui_enabled:
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
from tkinter import Tk, PhotoImage, Label, LabelFrame, Frame, Button
applyPromptWindow = Tk()
applyPromptWindow.resizable(False, False)
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
applyPromptWindow.protocol('WM_DELETE_WINDOW', lambda: onButtonClick())
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
logo = PhotoImage(file=Utils.local_path('data', 'icon.png'))
applyPromptWindow.tk.call('wm', 'iconphoto', applyPromptWindow._w, logo)
applyPromptWindow.wm_title("Last adjuster settings LttP")
label = LabelFrame(applyPromptWindow,
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
text='Last used adjuster settings were found. Would you like to apply these?')
label.grid(column=0, row=0, padx=5, pady=5, ipadx=5, ipady=5)
label.grid_columnconfigure(0, weight=1)
label.grid_columnconfigure(1, weight=1)
label.grid_columnconfigure(2, weight=1)
label.grid_columnconfigure(3, weight=1)
def onButtonClick(answer: str = 'no'):
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
setattr(onButtonClick, 'choice', answer)
applyPromptWindow.destroy()
framedOptions = Frame(label)
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
framedOptions.grid(column=0, columnspan=4, row=0)
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
framedOptions.grid_columnconfigure(0, weight=1)
framedOptions.grid_columnconfigure(1, weight=1)
framedOptions.grid_columnconfigure(2, weight=1)
curRow = 0
curCol = 0
for name, value in printed_options.items():
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
Label(framedOptions, text=name + ": " + str(value)).grid(column=curCol, row=curRow, padx=5)
if (curCol == 2):
curRow += 1
curCol = 0
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
else:
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
curCol += 1
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
yesButton = Button(label, text='Yes', command=lambda: onButtonClick('yes'), width=10)
yesButton.grid(column=0, row=1)
noButton = Button(label, text='No', command=lambda: onButtonClick('no'), width=10)
noButton.grid(column=1, row=1)
alwaysButton = Button(label, text='Always', command=lambda: onButtonClick('always'), width=10)
alwaysButton.grid(column=2, row=1)
neverButton = Button(label, text='Never', command=lambda: onButtonClick('never'), width=10)
neverButton.grid(column=3, row=1)
Utils.tkinter_center_window(applyPromptWindow)
applyPromptWindow.mainloop()
choice = getattr(onButtonClick, 'choice')
else:
choice = input(f"Last used adjuster settings were found. Would you like to apply these? \n"
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
f"{pprint.pformat(printed_options)}\n"
f"Enter yes, no, always or never: ")
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
if choice and choice.startswith("y"):
choice = 'yes'
elif choice and "never" in choice:
choice = 'no'
lastSettings.auto_apply = 'never'
Utils.persistent_store("adjuster", GAME_ALTTP, lastSettings)
elif choice and "always" in choice:
choice = 'yes'
lastSettings.auto_apply = 'always'
Utils.persistent_store("adjuster", GAME_ALTTP, lastSettings)
else:
choice = 'no'
elif 'never' in lastSettings.auto_apply:
choice = 'no'
elif 'always' in lastSettings.auto_apply:
choice = 'yes'
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
Adjuster fixes and added GUI prompt for applying last settings (#173)
2022-01-20 03:19:58 +00:00
if 'yes' in choice:
from worlds.alttp.Rom import get_base_rom_path
lastSettings.rom = romfile
lastSettings.baserom = get_base_rom_path()
lastSettings.world = None
if hasattr(lastSettings, "sprite_pool"):
from LttPAdjuster import AdjusterWorld
lastSettings.world = AdjusterWorld(getattr(lastSettings, "sprite_pool"))
adjusted = True
import LttPAdjuster
_, adjustedromfile = LttPAdjuster.adjust(lastSettings)
if hasattr(lastSettings, "world"):
delattr(lastSettings, "world")
else:
adjusted = False;
if adjusted:
try:
shutil.move(adjustedromfile, romfile)
adjustedromfile = romfile
except Exception as e:
logging.exception(e)
else:
adjusted = False
return adjustedromfile, adjusted
move networks commands to [str, Optional[dict]] across the board and some other updates PrintHTML is an experiment and is unlikely the solution I'll go with
2021-01-21 22:37:58 +00:00
MultiServer: allow multiple, ordered operations MultiServer: rename "data" on Get, Retrieved and SetNotify to "keys" MultiServer: add some more operators SniClient: some pep8 cleanup
2022-03-04 20:36:18 +00:00
multiworld
2019-12-09 18:27:56 +00:00
if __name__ == '__main__':
MultiClient: get rid of packages install hacks, use requirements.txt instead
2020-01-18 09:05:59 +00:00
colorama.init()
multiworld
2019-12-09 18:27:56 +00:00
loop = asyncio.get_event_loop()
loop.run_until_complete(main())
loop.close()
MultiClient: get rid of packages install hacks, use requirements.txt instead
2020-01-18 09:05:59 +00:00
colorama.deinit()