mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 20:21:32 -06:00
379 lines
16 KiB
Python
379 lines
16 KiB
Python
from __future__ import annotations
|
|
import os
|
|
import logging
|
|
import json
|
|
import string
|
|
import copy
|
|
import subprocess
|
|
import sys
|
|
import time
|
|
import random
|
|
|
|
import factorio_rcon
|
|
import colorama
|
|
import asyncio
|
|
from queue import Queue
|
|
import Utils
|
|
|
|
if __name__ == "__main__":
|
|
Utils.init_logging("FactorioClient", exception_logger="Client")
|
|
|
|
from CommonClient import CommonContext, server_loop, console_loop, ClientCommandProcessor, logger, gui_enabled, \
|
|
get_base_parser
|
|
from MultiServer import mark_raw
|
|
from NetUtils import NetworkItem, ClientStatus, JSONtoTextParser, JSONMessagePart
|
|
|
|
from worlds.factorio import Factorio
|
|
|
|
|
|
class FactorioCommandProcessor(ClientCommandProcessor):
|
|
ctx: FactorioContext
|
|
|
|
@mark_raw
|
|
def _cmd_factorio(self, text: str) -> bool:
|
|
"""Send the following command to the bound Factorio Server."""
|
|
if self.ctx.rcon_client:
|
|
# TODO: Print the command non-silently only for race seeds, or otherwise block anything but /factorio /save in race seeds.
|
|
self.ctx.print_to_game(f"/factorio {text}")
|
|
result = self.ctx.rcon_client.send_command(text)
|
|
if result:
|
|
self.output(result)
|
|
return True
|
|
return False
|
|
|
|
def _cmd_resync(self):
|
|
"""Manually trigger a resync."""
|
|
self.ctx.awaiting_bridge = True
|
|
|
|
|
|
class FactorioContext(CommonContext):
|
|
command_processor = FactorioCommandProcessor
|
|
game = "Factorio"
|
|
|
|
# updated by spinup server
|
|
mod_version: Utils.Version = Utils.Version(0, 0, 0)
|
|
|
|
def __init__(self, server_address, password):
|
|
super(FactorioContext, self).__init__(server_address, password)
|
|
self.send_index: int = 0
|
|
self.rcon_client = None
|
|
self.awaiting_bridge = False
|
|
self.write_data_path = None
|
|
self.death_link_tick: int = 0 # last send death link on Factorio layer
|
|
self.factorio_json_text_parser = FactorioJSONtoTextParser(self)
|
|
|
|
async def server_auth(self, password_requested: bool = False):
|
|
if password_requested and not self.password:
|
|
await super(FactorioContext, self).server_auth(password_requested)
|
|
|
|
if self.rcon_client:
|
|
await get_info(self, self.rcon_client) # retrieve current auth code
|
|
else:
|
|
raise Exception("Cannot connect to a server with unknown own identity, "
|
|
"bridge to Factorio first.")
|
|
|
|
await self.send_connect()
|
|
|
|
def on_print(self, args: dict):
|
|
super(FactorioContext, self).on_print(args)
|
|
if self.rcon_client:
|
|
self.print_to_game(args['text'])
|
|
|
|
def on_print_json(self, args: dict):
|
|
if self.rcon_client:
|
|
text = self.factorio_json_text_parser(copy.deepcopy(args["data"]))
|
|
self.print_to_game(text)
|
|
super(FactorioContext, self).on_print_json(args)
|
|
|
|
@property
|
|
def savegame_name(self) -> str:
|
|
return f"AP_{self.seed_name}_{self.auth}_Save.zip"
|
|
|
|
def print_to_game(self, text):
|
|
self.rcon_client.send_command(f"/ap-print [font=default-large-bold]Archipelago:[/font] "
|
|
f"{text}")
|
|
|
|
def on_deathlink(self, data: dict):
|
|
if self.rcon_client:
|
|
self.rcon_client.send_command(f"/ap-deathlink {data['source']}")
|
|
super(FactorioContext, self).on_deathlink(data)
|
|
|
|
def on_package(self, cmd: str, args: dict):
|
|
if cmd in {"Connected", "RoomUpdate"}:
|
|
# catch up sync anything that is already cleared.
|
|
if "checked_locations" in args and args["checked_locations"]:
|
|
self.rcon_client.send_commands({item_name: f'/ap-get-technology ap-{item_name}-\t-1' for
|
|
item_name in args["checked_locations"]})
|
|
|
|
|
|
async def game_watcher(ctx: FactorioContext):
|
|
bridge_logger = logging.getLogger("FactorioWatcher")
|
|
from worlds.factorio.Technologies import lookup_id_to_name
|
|
next_bridge = time.perf_counter() + 1
|
|
try:
|
|
while not ctx.exit_event.is_set():
|
|
if ctx.awaiting_bridge and ctx.rcon_client and time.perf_counter() > next_bridge:
|
|
next_bridge = time.perf_counter() + 1
|
|
ctx.awaiting_bridge = False
|
|
data = json.loads(ctx.rcon_client.send_command("/ap-sync"))
|
|
if data["slot_name"] != ctx.auth:
|
|
bridge_logger.warning(f"Connected World is not the expected one {data['slot_name']} != {ctx.auth}")
|
|
elif data["seed_name"] != ctx.seed_name:
|
|
bridge_logger.warning(
|
|
f"Connected Multiworld is not the expected one {data['seed_name']} != {ctx.seed_name}")
|
|
else:
|
|
data = data["info"]
|
|
research_data = data["research_done"]
|
|
research_data = {int(tech_name.split("-")[1]) for tech_name in research_data}
|
|
victory = data["victory"]
|
|
if "death_link" in data: # TODO: Remove this if statement around version 0.2.4 or so
|
|
await ctx.update_death_link(data["death_link"])
|
|
|
|
if not ctx.finished_game and victory:
|
|
await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
|
|
ctx.finished_game = True
|
|
|
|
if ctx.locations_checked != research_data:
|
|
bridge_logger.debug(
|
|
f"New researches done: "
|
|
f"{[lookup_id_to_name[rid] for rid in research_data - ctx.locations_checked]}")
|
|
ctx.locations_checked = research_data
|
|
await ctx.send_msgs([{"cmd": 'LocationChecks', "locations": tuple(research_data)}])
|
|
death_link_tick = data.get("death_link_tick", 0)
|
|
if death_link_tick != ctx.death_link_tick:
|
|
ctx.death_link_tick = death_link_tick
|
|
if "DeathLink" in ctx.tags:
|
|
await ctx.send_death()
|
|
|
|
await asyncio.sleep(0.1)
|
|
|
|
except Exception as e:
|
|
logging.exception(e)
|
|
logging.error("Aborted Factorio Server Bridge")
|
|
|
|
|
|
def stream_factorio_output(pipe, queue, process):
|
|
def queuer():
|
|
while process.poll() is None:
|
|
text = pipe.readline().strip()
|
|
if text:
|
|
queue.put_nowait(text)
|
|
|
|
from threading import Thread
|
|
|
|
thread = Thread(target=queuer, name="Factorio Output Queue", daemon=True)
|
|
thread.start()
|
|
return thread
|
|
|
|
|
|
async def factorio_server_watcher(ctx: FactorioContext):
|
|
savegame_name = os.path.abspath(ctx.savegame_name)
|
|
if not os.path.exists(savegame_name):
|
|
logger.info(f"Creating savegame {savegame_name}")
|
|
subprocess.run((
|
|
executable, "--create", savegame_name, "--preset", "archipelago"
|
|
))
|
|
factorio_process = subprocess.Popen((executable, "--start-server", ctx.savegame_name,
|
|
*(str(elem) for elem in server_args)),
|
|
stderr=subprocess.PIPE,
|
|
stdout=subprocess.PIPE,
|
|
stdin=subprocess.DEVNULL,
|
|
encoding="utf-8")
|
|
factorio_server_logger.info("Started Factorio Server")
|
|
factorio_queue = Queue()
|
|
stream_factorio_output(factorio_process.stdout, factorio_queue, factorio_process)
|
|
stream_factorio_output(factorio_process.stderr, factorio_queue, factorio_process)
|
|
try:
|
|
while not ctx.exit_event.is_set():
|
|
if factorio_process.poll():
|
|
factorio_server_logger.info("Factorio server has exited.")
|
|
ctx.exit_event.set()
|
|
|
|
while not factorio_queue.empty():
|
|
msg = factorio_queue.get()
|
|
factorio_queue.task_done()
|
|
|
|
if not ctx.rcon_client and "Starting RCON interface at IP ADDR:" in msg:
|
|
ctx.rcon_client = factorio_rcon.RCONClient("localhost", rcon_port, rcon_password)
|
|
if not ctx.server:
|
|
logger.info("Established bridge to Factorio Server. "
|
|
"Ready to connect to Archipelago via /connect")
|
|
|
|
if not ctx.awaiting_bridge and "Archipelago Bridge Data available for game tick " in msg:
|
|
ctx.awaiting_bridge = True
|
|
factorio_server_logger.debug(msg)
|
|
else:
|
|
factorio_server_logger.info(msg)
|
|
if ctx.rcon_client:
|
|
commands = {}
|
|
while ctx.send_index < len(ctx.items_received):
|
|
transfer_item: NetworkItem = ctx.items_received[ctx.send_index]
|
|
item_id = transfer_item.item
|
|
player_name = ctx.player_names[transfer_item.player]
|
|
if item_id not in Factorio.item_id_to_name:
|
|
factorio_server_logger.error(f"Cannot send unknown item ID: {item_id}")
|
|
else:
|
|
item_name = Factorio.item_id_to_name[item_id]
|
|
factorio_server_logger.info(f"Sending {item_name} to Nauvis from {player_name}.")
|
|
commands[ctx.send_index] = f'/ap-get-technology {item_name}\t{ctx.send_index}\t{player_name}'
|
|
ctx.send_index += 1
|
|
if commands:
|
|
ctx.rcon_client.send_commands(commands)
|
|
await asyncio.sleep(0.1)
|
|
|
|
except Exception as e:
|
|
logging.exception(e)
|
|
logging.error("Aborted Factorio Server Bridge")
|
|
ctx.rcon_client = None
|
|
ctx.exit_event.set()
|
|
|
|
finally:
|
|
factorio_process.terminate()
|
|
factorio_process.wait(5)
|
|
|
|
|
|
async def get_info(ctx, rcon_client):
|
|
info = json.loads(rcon_client.send_command("/ap-rcon-info"))
|
|
ctx.auth = info["slot_name"]
|
|
ctx.seed_name = info["seed_name"]
|
|
# 0.2.0 addition, not present earlier
|
|
death_link = bool(info.get("death_link", False))
|
|
await ctx.update_death_link(death_link)
|
|
|
|
|
|
async def factorio_spinup_server(ctx: FactorioContext) -> bool:
|
|
savegame_name = os.path.abspath("Archipelago.zip")
|
|
if not os.path.exists(savegame_name):
|
|
logger.info(f"Creating savegame {savegame_name}")
|
|
subprocess.run((
|
|
executable, "--create", savegame_name
|
|
))
|
|
factorio_process = subprocess.Popen(
|
|
(executable, "--start-server", savegame_name, *(str(elem) for elem in server_args)),
|
|
stderr=subprocess.PIPE,
|
|
stdout=subprocess.PIPE,
|
|
stdin=subprocess.DEVNULL,
|
|
encoding="utf-8")
|
|
factorio_server_logger.info("Started Information Exchange Factorio Server")
|
|
factorio_queue = Queue()
|
|
stream_factorio_output(factorio_process.stdout, factorio_queue, factorio_process)
|
|
stream_factorio_output(factorio_process.stderr, factorio_queue, factorio_process)
|
|
rcon_client = None
|
|
try:
|
|
while not ctx.auth:
|
|
while not factorio_queue.empty():
|
|
msg = factorio_queue.get()
|
|
factorio_server_logger.info(msg)
|
|
if "Loading mod AP-" in msg and msg.endswith("(data.lua)"):
|
|
parts = msg.split()
|
|
ctx.mod_version = Utils.Version(*(int(number) for number in parts[-2].split(".")))
|
|
elif "Write data path: " in msg:
|
|
ctx.write_data_path = Utils.get_text_between(msg, "Write data path: ", " [")
|
|
if "AppData" in ctx.write_data_path:
|
|
logger.warning("It appears your mods are loaded from Appdata, "
|
|
"this can lead to problems with multiple Factorio instances. "
|
|
"If this is the case, you will get a file locked error running Factorio.")
|
|
if not rcon_client and "Starting RCON interface at IP ADDR:" in msg:
|
|
rcon_client = factorio_rcon.RCONClient("localhost", rcon_port, rcon_password)
|
|
if ctx.mod_version == ctx.__class__.mod_version:
|
|
raise Exception("No Archipelago mod was loaded. Aborting.")
|
|
await get_info(ctx, rcon_client)
|
|
await asyncio.sleep(0.01)
|
|
|
|
except Exception as e:
|
|
logger.exception(e)
|
|
logger.error("Aborted Factorio Server Bridge")
|
|
ctx.exit_event.set()
|
|
|
|
else:
|
|
logger.info(
|
|
f"Got World Information from AP Mod {tuple(ctx.mod_version)} for seed {ctx.seed_name} in slot {ctx.auth}")
|
|
return True
|
|
finally:
|
|
factorio_process.terminate()
|
|
factorio_process.wait(5)
|
|
return False
|
|
|
|
|
|
async def main(args):
|
|
ctx = FactorioContext(args.connect, args.password)
|
|
ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
|
|
input_task = None
|
|
if gui_enabled:
|
|
from kvui import FactorioManager
|
|
ctx.ui = FactorioManager(ctx)
|
|
ui_task = asyncio.create_task(ctx.ui.async_run(), name="UI")
|
|
else:
|
|
ui_task = None
|
|
if sys.stdin:
|
|
input_task = asyncio.create_task(console_loop(ctx), name="Input")
|
|
factorio_server_task = asyncio.create_task(factorio_spinup_server(ctx), name="FactorioSpinupServer")
|
|
succesful_launch = await factorio_server_task
|
|
if succesful_launch:
|
|
factorio_server_task = asyncio.create_task(factorio_server_watcher(ctx), name="FactorioServer")
|
|
progression_watcher = asyncio.create_task(
|
|
game_watcher(ctx), name="FactorioProgressionWatcher")
|
|
|
|
await ctx.exit_event.wait()
|
|
ctx.server_address = None
|
|
|
|
await progression_watcher
|
|
await factorio_server_task
|
|
|
|
await ctx.shutdown()
|
|
|
|
if ui_task:
|
|
await ui_task
|
|
|
|
if input_task:
|
|
input_task.cancel()
|
|
|
|
|
|
class FactorioJSONtoTextParser(JSONtoTextParser):
|
|
def _handle_color(self, node: JSONMessagePart):
|
|
colors = node["color"].split(";")
|
|
for color in colors:
|
|
if color in {"red", "green", "blue", "orange", "yellow", "pink", "purple", "white", "black", "gray",
|
|
"brown", "cyan", "acid"}:
|
|
node["text"] = f"[color={color}]{node['text']}[/color]"
|
|
return self._handle_text(node)
|
|
elif color == "magenta":
|
|
node["text"] = f"[color=pink]{node['text']}[/color]"
|
|
return self._handle_text(node)
|
|
return self._handle_text(node)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
parser = get_base_parser(description="Optional arguments to FactorioClient follow. "
|
|
"Remaining arguments get passed into bound Factorio instance."
|
|
"Refer to Factorio --help for those.")
|
|
parser.add_argument('--rcon-port', default='24242', type=int, help='Port to use to communicate with Factorio')
|
|
parser.add_argument('--rcon-password', help='Password to authenticate with RCON.')
|
|
|
|
args, rest = parser.parse_known_args()
|
|
colorama.init()
|
|
rcon_port = args.rcon_port
|
|
rcon_password = args.rcon_password if args.rcon_password else ''.join(
|
|
random.choice(string.ascii_letters) for x in range(32))
|
|
|
|
factorio_server_logger = logging.getLogger("FactorioServer")
|
|
options = Utils.get_options()
|
|
executable = options["factorio_options"]["executable"]
|
|
|
|
if not os.path.exists(os.path.dirname(executable)):
|
|
raise FileNotFoundError(f"Path {os.path.dirname(executable)} does not exist or could not be accessed.")
|
|
if os.path.isdir(executable): # user entered a path to a directory, let's find the executable therein
|
|
executable = os.path.join(executable, "factorio")
|
|
if not os.path.isfile(executable):
|
|
if os.path.isfile(executable + ".exe"):
|
|
executable = executable + ".exe"
|
|
else:
|
|
raise FileNotFoundError(f"Path {executable} is not an executable file.")
|
|
|
|
server_args = ("--rcon-port", rcon_port, "--rcon-password", rcon_password, *rest)
|
|
|
|
loop = asyncio.get_event_loop()
|
|
loop.run_until_complete(main(args))
|
|
loop.close()
|
|
colorama.deinit()
|