Skip to content

Commit

Permalink
Improve commands
Browse files Browse the repository at this point in the history
  • Loading branch information
@EmilyV99
EmilyV99 committed Mar 23, 2024
1 parent bdd498d commit b1446c7
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 39 deletions.
107 changes: 73 additions & 34 deletions CommonClient.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
if __name__ == "__main__":
Utils.init_logging("TextClient", exception_logger="Client")

from MultiServer import CommandProcessor
from MultiServer import CommandProcessor, mark_raw
from NetUtils import (Endpoint, decode, NetworkItem, encode, JSONtoTextParser, ClientStatus, Permission, NetworkSlot,
RawJSONtoTextParser, add_json_text, add_json_location, add_json_item, JSONTypes)
from Utils import Version, stream_input, async_start
Expand Down Expand Up @@ -70,21 +70,35 @@ def _cmd_disconnect(self) -> bool:
async_start(self.ctx.disconnect(), name="disconnecting")
return True

def _cmd_received(self) -> bool:
"""List all received items"""
item: NetworkItem
self.output(f'{len(self.ctx.items_received)} received items, sorted by time:')
for index, item in enumerate(self.ctx.items_received, 1):
parts = []
add_json_item(parts, item.item, self.ctx.slot, item.flags)
add_json_text(parts, " from ")
add_json_location(parts, item.location, item.player)
add_json_text(parts, " by ")
add_json_text(parts, item.player, type=JSONTypes.player_id)
self.ctx.on_print_json({"data": parts, "cmd": "PrintJSON"})
@mark_raw
def _cmd_received(self, filter_text: str = "") -> bool:
"""List all received items.
Can be given text, which will be used as filter."""
count = 0
if filter_text:
self.output(f"Received items matching '{filter_text}':")
else:
self.output("Received items:")
self.output("")
for item in self.ctx.items_received:
item_name = self.ctx.item_names[item.item]
if not filter_text or filter_text.lower() in item_name.lower():
count += 1
parts = []
add_json_item(parts, item.item, self.ctx.slot, item.flags)
add_json_text(parts, " from ")
add_json_location(parts, item.location, item.player)
add_json_text(parts, " by ")
add_json_text(parts, item.player, type=JSONTypes.player_id)
self.ctx.on_print_json({"data": parts, "cmd": "PrintJSON"})
if count == 0:
self.output("No received items found")
else:
self.output(f"Found {count} {'matching ' if filter_text else ''}received items")
return True

def _cmd_missing(self, filter_text = "") -> bool:
@mark_raw
def _cmd_missing(self, filter_text: str = "") -> bool:
"""List all missing location checks, from your local game state.
Can be given text, which will be used as filter."""
if not self.ctx.game:
Expand All @@ -93,7 +107,7 @@ def _cmd_missing(self, filter_text = "") -> bool:
count = 0
checked_count = 0
for location, location_id in AutoWorldRegister.world_types[self.ctx.game].location_name_to_id.items():
if filter_text and filter_text not in location:
if filter_text and filter_text.lower() not in location.lower():
continue
if location_id < 0:
continue
Expand All @@ -108,46 +122,71 @@ def _cmd_missing(self, filter_text = "") -> bool:

if count:
self.output(
f"Found {count} missing location checks{f'. {checked_count} location checks previously visited.' if checked_count else ''}")
f"Found {count} missing location checks{f" matching '{filter_text}'" if filter_text else ""}{f'. {checked_count} location checks previously visited.' if checked_count else ''}")
else:
self.output("No missing location checks found.")
self.output(f"No missing location checks{f" matching '{filter_text}'" if filter_text else ""} found.")
return True

def _cmd_items(self):
"""List all item names for the currently running game."""
@mark_raw
def _cmd_items(self, filter_text: str = ""):
"""List all item names for the currently running game.
Can be given text, which will be used as filter."""
if not self.ctx.game:
self.output("No game set, cannot determine existing items.")
return False
self.output(f"Item Names for {self.ctx.game}")
if filter_text:
self.output(f"Item Names for {self.ctx.game} matching '{filter_text}':")
else:
self.output(f"Item Names for {self.ctx.game}:")
self.output("")
for item_name in AutoWorldRegister.world_types[self.ctx.game].item_name_to_id:
self.output(item_name)

def _cmd_item_groups(self):
"""List all item group names for the currently running game."""
if not filter_text or filter_text.lower() in item_name.lower():
self.output(item_name)

@mark_raw
def _cmd_item_groups(self, filter_text = ""):
"""List all item group names for the currently running game.
Can be given text, which will be used as filter."""
if not self.ctx.game:
self.output("No game set, cannot determine existing item groups.")
return False
self.output(f"Item Group Names for {self.ctx.game}")
if filter_text:
self.output(f"Item Group Names for {self.ctx.game} matching '{filter_text}':")
else:
self.output(f"Item Group Names for {self.ctx.game}:")
for group_name in AutoWorldRegister.world_types[self.ctx.game].item_name_groups:
self.output(group_name)

def _cmd_locations(self):
"""List all location names for the currently running game."""
if not filter_text or filter_text.lower() in group_name.lower():
self.output(group_name)

@mark_raw
def _cmd_locations(self, filter_text: str = ""):
"""List all location names for the currently running game.
Can be given text, which will be used as filter."""
if not self.ctx.game:
self.output("No game set, cannot determine existing locations.")
return False
self.output(f"Location Names for {self.ctx.game}")
if filter_text:
self.output(f"Location Names for {self.ctx.game} matching '{filter_text}':")
else:
self.output(f"Location Names for {self.ctx.game}:")
self.output("")
for location_name in AutoWorldRegister.world_types[self.ctx.game].location_name_to_id:
self.output(location_name)
if not filter_text or filter_text.lower() in location_name.lower():
self.output(location_name)

def _cmd_location_groups(self):
"""List all location group names for the currently running game."""
"""List all location group names for the currently running game.
Can be given text, which will be used as filter."""
if not self.ctx.game:
self.output("No game set, cannot determine existing location groups.")
return False
self.output(f"Location Group Names for {self.ctx.game}")
if filter_text:
self.output(f"Location Group Names for {self.ctx.game} matching '{filter_text}':")
else:
self.output(f"Location Group Names for {self.ctx.game}:")
for group_name in AutoWorldRegister.world_types[self.ctx.game].location_name_groups:
self.output(group_name)
if not filter_text or filter_text.lower() in group_name.lower():
self.output(group_name)

def _cmd_ready(self):
"""Send ready status to server."""
Expand Down
12 changes: 7 additions & 5 deletions MultiServer.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1346,7 +1346,8 @@ def _cmd_remaining(self) -> bool:
self.output(
"Sorry, !remaining requires you to have beaten the game on this server")
return False


@mark_raw
def _cmd_missing(self, filter_text="") -> bool:
"""List all missing location checks from the server's perspective.
Can be given text, which will be used as filter."""
Expand All @@ -1356,17 +1357,18 @@ def _cmd_missing(self, filter_text="") -> bool:
if locations:
names = [self.ctx.location_names[location] for location in locations]
if filter_text:
names = [name for name in names if filter_text in name]
names = [name for name in names if filter_text.lower() in name.lower()]
texts = [f'Missing: {name}' for name in names]
if filter_text:
texts.append(f"Found {len(locations)} missing location checks, displaying {len(names)} of them.")
texts.append(f"Found {len(names)} missing location checks matching '{filter_text}'")
else:
texts.append(f"Found {len(locations)} missing location checks")
self.output_multiple(texts)
else:
self.output("No missing location checks found.")
return True

@mark_raw
def _cmd_checked(self, filter_text="") -> bool:
"""List all done location checks from the server's perspective.
Can be given text, which will be used as filter."""
Expand All @@ -1376,10 +1378,10 @@ def _cmd_checked(self, filter_text="") -> bool:
if locations:
names = [self.ctx.location_names[location] for location in locations]
if filter_text:
names = [name for name in names if filter_text in name]
names = [name for name in names if filter_text.lower() in name.lower()]
texts = [f'Checked: {name}' for name in names]
if filter_text:
texts.append(f"Found {len(locations)} done location checks, displaying {len(names)} of them.")
texts.append(f"Found {len(names)} done location checks matching '{filter_text}'")
else:
texts.append(f"Found {len(locations)} done location checks")
self.output_multiple(texts)
Expand Down

0 comments on commit b1446c7

Please sign in to comment.