268 lines
10 KiB
Python
268 lines
10 KiB
Python
import asyncio
|
|
import copy
|
|
import json
|
|
import time
|
|
from asyncio import StreamReader, StreamWriter
|
|
from typing import List
|
|
|
|
|
|
import Utils
|
|
from Utils import async_start
|
|
from CommonClient import CommonContext, server_loop, gui_enabled, ClientCommandProcessor, logger, \
|
|
get_base_parser
|
|
|
|
SYSTEM_MESSAGE_ID = 0
|
|
|
|
CONNECTION_TIMING_OUT_STATUS = "Connection timing out. Please restart your emulator, then restart connector_ff1.lua"
|
|
CONNECTION_REFUSED_STATUS = "Connection Refused. Please start your emulator and make sure connector_ff1.lua is running"
|
|
CONNECTION_RESET_STATUS = "Connection was reset. Please restart your emulator, then restart connector_ff1.lua"
|
|
CONNECTION_TENTATIVE_STATUS = "Initial Connection Made"
|
|
CONNECTION_CONNECTED_STATUS = "Connected"
|
|
CONNECTION_INITIAL_STATUS = "Connection has not been initiated"
|
|
|
|
DISPLAY_MSGS = True
|
|
|
|
|
|
class FF1CommandProcessor(ClientCommandProcessor):
|
|
def __init__(self, ctx: CommonContext):
|
|
super().__init__(ctx)
|
|
|
|
def _cmd_nes(self):
|
|
"""Check NES Connection State"""
|
|
if isinstance(self.ctx, FF1Context):
|
|
logger.info(f"NES Status: {self.ctx.nes_status}")
|
|
|
|
def _cmd_toggle_msgs(self):
|
|
"""Toggle displaying messages in EmuHawk"""
|
|
global DISPLAY_MSGS
|
|
DISPLAY_MSGS = not DISPLAY_MSGS
|
|
logger.info(f"Messages are now {'enabled' if DISPLAY_MSGS else 'disabled'}")
|
|
|
|
|
|
class FF1Context(CommonContext):
|
|
command_processor = FF1CommandProcessor
|
|
game = 'Final Fantasy'
|
|
items_handling = 0b111 # full remote
|
|
|
|
def __init__(self, server_address, password):
|
|
super().__init__(server_address, password)
|
|
self.nes_streams: (StreamReader, StreamWriter) = None
|
|
self.nes_sync_task = None
|
|
self.messages = {}
|
|
self.locations_array = None
|
|
self.nes_status = CONNECTION_INITIAL_STATUS
|
|
self.awaiting_rom = False
|
|
self.display_msgs = True
|
|
|
|
async def server_auth(self, password_requested: bool = False):
|
|
if password_requested and not self.password:
|
|
await super(FF1Context, self).server_auth(password_requested)
|
|
if not self.auth:
|
|
self.awaiting_rom = True
|
|
logger.info('Awaiting connection to NES to get Player information')
|
|
return
|
|
|
|
await self.send_connect()
|
|
|
|
def _set_message(self, msg: str, msg_id: int):
|
|
if DISPLAY_MSGS:
|
|
self.messages[time.time(), msg_id] = msg
|
|
|
|
def on_package(self, cmd: str, args: dict):
|
|
if cmd == 'Connected':
|
|
async_start(parse_locations(self.locations_array, self, True))
|
|
elif cmd == 'Print':
|
|
msg = args['text']
|
|
if ': !' not in msg:
|
|
self._set_message(msg, SYSTEM_MESSAGE_ID)
|
|
|
|
def on_print_json(self, args: dict):
|
|
if self.ui:
|
|
self.ui.print_json(copy.deepcopy(args["data"]))
|
|
else:
|
|
text = self.jsontotextparser(copy.deepcopy(args["data"]))
|
|
logger.info(text)
|
|
relevant = args.get("type", None) in {"Hint", "ItemSend"}
|
|
if relevant:
|
|
item = args["item"]
|
|
# goes to this world
|
|
if self.slot_concerns_self(args["receiving"]):
|
|
relevant = True
|
|
# found in this world
|
|
elif self.slot_concerns_self(item.player):
|
|
relevant = True
|
|
# not related
|
|
else:
|
|
relevant = False
|
|
if relevant:
|
|
item = args["item"]
|
|
msg = self.raw_text_parser(copy.deepcopy(args["data"]))
|
|
self._set_message(msg, item.item)
|
|
|
|
def run_gui(self):
|
|
from kvui import GameManager
|
|
|
|
class FF1Manager(GameManager):
|
|
logging_pairs = [
|
|
("Client", "Archipelago")
|
|
]
|
|
base_title = "Archipelago Final Fantasy 1 Client"
|
|
|
|
self.ui = FF1Manager(self)
|
|
self.ui_task = asyncio.create_task(self.ui.async_run(), name="UI")
|
|
|
|
|
|
def get_payload(ctx: FF1Context):
|
|
current_time = time.time()
|
|
return json.dumps(
|
|
{
|
|
"items": [item.item for item in ctx.items_received],
|
|
"messages": {f'{key[0]}:{key[1]}': value for key, value in ctx.messages.items()
|
|
if key[0] > current_time - 10}
|
|
}
|
|
)
|
|
|
|
|
|
async def parse_locations(locations_array: List[int], ctx: FF1Context, force: bool):
|
|
if locations_array == ctx.locations_array and not force:
|
|
return
|
|
else:
|
|
# print("New values")
|
|
ctx.locations_array = locations_array
|
|
locations_checked = []
|
|
if len(locations_array) > 0xFE and locations_array[0xFE] & 0x02 != 0 and not ctx.finished_game:
|
|
await ctx.send_msgs([
|
|
{"cmd": "StatusUpdate",
|
|
"status": 30}
|
|
])
|
|
ctx.finished_game = True
|
|
for location in ctx.missing_locations:
|
|
# index will be - 0x100 or 0x200
|
|
index = location
|
|
if location < 0x200:
|
|
# Location is a chest
|
|
index -= 0x100
|
|
flag = 0x04
|
|
else:
|
|
# Location is an NPC
|
|
index -= 0x200
|
|
flag = 0x02
|
|
|
|
# print(f"Location: {ctx.location_names[location]}")
|
|
# print(f"Index: {str(hex(index))}")
|
|
# print(f"value: {locations_array[index] & flag != 0}")
|
|
if locations_array[index] & flag != 0:
|
|
locations_checked.append(location)
|
|
if locations_checked:
|
|
# print([ctx.location_names[location] for location in locations_checked])
|
|
await ctx.send_msgs([
|
|
{"cmd": "LocationChecks",
|
|
"locations": locations_checked}
|
|
])
|
|
|
|
|
|
async def nes_sync_task(ctx: FF1Context):
|
|
logger.info("Starting nes connector. Use /nes for status information")
|
|
while not ctx.exit_event.is_set():
|
|
error_status = None
|
|
if ctx.nes_streams:
|
|
(reader, writer) = ctx.nes_streams
|
|
msg = get_payload(ctx).encode()
|
|
writer.write(msg)
|
|
writer.write(b'\n')
|
|
try:
|
|
await asyncio.wait_for(writer.drain(), timeout=1.5)
|
|
try:
|
|
# Data will return a dict with up to two fields:
|
|
# 1. A keepalive response of the Players Name (always)
|
|
# 2. An array representing the memory values of the locations area (if in game)
|
|
data = await asyncio.wait_for(reader.readline(), timeout=5)
|
|
data_decoded = json.loads(data.decode())
|
|
# print(data_decoded)
|
|
if ctx.game is not None and 'locations' in data_decoded:
|
|
# Not just a keep alive ping, parse
|
|
async_start(parse_locations(data_decoded['locations'], ctx, False))
|
|
if not ctx.auth:
|
|
ctx.auth = ''.join([chr(i) for i in data_decoded['playerName'] if i != 0])
|
|
if ctx.auth == '':
|
|
logger.info("Invalid ROM detected. No player name built into the ROM. Please regenerate"
|
|
"the ROM using the same link but adding your slot name")
|
|
if ctx.awaiting_rom:
|
|
await ctx.server_auth(False)
|
|
except asyncio.TimeoutError:
|
|
logger.debug("Read Timed Out, Reconnecting")
|
|
error_status = CONNECTION_TIMING_OUT_STATUS
|
|
writer.close()
|
|
ctx.nes_streams = None
|
|
except ConnectionResetError as e:
|
|
logger.debug("Read failed due to Connection Lost, Reconnecting")
|
|
error_status = CONNECTION_RESET_STATUS
|
|
writer.close()
|
|
ctx.nes_streams = None
|
|
except TimeoutError:
|
|
logger.debug("Connection Timed Out, Reconnecting")
|
|
error_status = CONNECTION_TIMING_OUT_STATUS
|
|
writer.close()
|
|
ctx.nes_streams = None
|
|
except ConnectionResetError:
|
|
logger.debug("Connection Lost, Reconnecting")
|
|
error_status = CONNECTION_RESET_STATUS
|
|
writer.close()
|
|
ctx.nes_streams = None
|
|
if ctx.nes_status == CONNECTION_TENTATIVE_STATUS:
|
|
if not error_status:
|
|
logger.info("Successfully Connected to NES")
|
|
ctx.nes_status = CONNECTION_CONNECTED_STATUS
|
|
else:
|
|
ctx.nes_status = f"Was tentatively connected but error occured: {error_status}"
|
|
elif error_status:
|
|
ctx.nes_status = error_status
|
|
logger.info("Lost connection to nes and attempting to reconnect. Use /nes for status updates")
|
|
else:
|
|
try:
|
|
logger.debug("Attempting to connect to NES")
|
|
ctx.nes_streams = await asyncio.wait_for(asyncio.open_connection("localhost", 52980), timeout=10)
|
|
ctx.nes_status = CONNECTION_TENTATIVE_STATUS
|
|
except TimeoutError:
|
|
logger.debug("Connection Timed Out, Trying Again")
|
|
ctx.nes_status = CONNECTION_TIMING_OUT_STATUS
|
|
continue
|
|
except ConnectionRefusedError:
|
|
logger.debug("Connection Refused, Trying Again")
|
|
ctx.nes_status = CONNECTION_REFUSED_STATUS
|
|
continue
|
|
|
|
|
|
if __name__ == '__main__':
|
|
# Text Mode to use !hint and such with games that have no text entry
|
|
Utils.init_logging("FF1Client")
|
|
|
|
options = Utils.get_options()
|
|
DISPLAY_MSGS = options["ffr_options"]["display_msgs"]
|
|
|
|
async def main(args):
|
|
ctx = FF1Context(args.connect, args.password)
|
|
ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
|
|
if gui_enabled:
|
|
ctx.run_gui()
|
|
ctx.run_cli()
|
|
ctx.nes_sync_task = asyncio.create_task(nes_sync_task(ctx), name="NES Sync")
|
|
|
|
await ctx.exit_event.wait()
|
|
ctx.server_address = None
|
|
|
|
await ctx.shutdown()
|
|
|
|
if ctx.nes_sync_task:
|
|
await ctx.nes_sync_task
|
|
|
|
|
|
import colorama
|
|
|
|
parser = get_base_parser()
|
|
args = parser.parse_args()
|
|
colorama.init()
|
|
|
|
asyncio.run(main(args))
|
|
colorama.deinit()
|