Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BizHawkClient: Add BizHawkClient #1978

Merged
merged 29 commits into from
Oct 3, 2023
Merged
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
ba8e9ab
BizHawkClient: Add client and connector
Zunawe Jul 8, 2023
fd0bec4
BizHawkClient: Add launcher component and inno_setup lines
Zunawe Jul 8, 2023
0e4d73e
BizHawkClient: Misc stability updates and small improvements
Zunawe Jul 10, 2023
ebb58a7
BizHawkClient: Add docstrings
Zunawe Jul 10, 2023
de4955e
BizHawkClient: Pull in changes from other branch
Zunawe Jul 15, 2023
8dd4b2e
BizHawkClient: Fix no handler message not displaying after changed ROMs
Zunawe Jul 15, 2023
b3a731b
BizHawkClient: Remove extra print statement from lua
Zunawe Jul 15, 2023
5e61db0
BizHawkClient: Change version command to use raw strings
Zunawe Jul 15, 2023
6c029d2
BizHawkClient: Change script version to single integer
Zunawe Jul 15, 2023
9603f16
BizHawkClient: Add newline to version for lua script
Zunawe Aug 3, 2023
311502b
BizHawkClient: Call send_connect from BizHawkClient's watcher loop
Zunawe Aug 3, 2023
7b30378
BizHawkClient: Add handling for failed request getting script version
Zunawe Aug 3, 2023
eda1308
BizHawkClient: Have base64.lua check lua version explicitly for bit o…
Zunawe Aug 3, 2023
b59429f
BizHawkClient: Update connector script for slightly better errors and…
Zunawe Aug 3, 2023
f05e7e5
BizHawkClient: Remove accidentally added print statements
Zunawe Aug 3, 2023
254a9aa
BizHawkClient: Fix connector server not closing correctly
Zunawe Aug 4, 2023
5190ac3
BizHawkClient: Move some connector code around, some linting
Zunawe Aug 4, 2023
d56404c
BizHawkClient: Small cleanup in lua
Zunawe Aug 4, 2023
d57ed99
BizHawkClient: Lua linting
Zunawe Aug 10, 2023
0929b6c
BizHawkClient: Remove outdated sentences in docstrings
Zunawe Aug 10, 2023
92bd09a
Merge remote-tracking branch 'upstream/main' into bh-client
Zunawe Aug 16, 2023
361c0b5
BizHawkClient: Correctly null check patch file arg
Zunawe Aug 16, 2023
55df7b0
BizHawkClient: Initialize logging
Zunawe Aug 16, 2023
4e2151a
BizHawkClient: Move code to worlds/_bizhawk
Zunawe Aug 29, 2023
f7b5881
BizHawkClient: Add license to connector lua, add types to docs
Zunawe Aug 29, 2023
e87f0b2
BizHawkClient: Add module docstrings
Zunawe Aug 29, 2023
d706c3f
BizHawkClient: Allow clients to define multiple systems
Zunawe Sep 4, 2023
932315b
BizHawkClient: Better logging and handling of interruptions to connec…
Zunawe Sep 9, 2023
97583f1
Merge branch 'main' into bh-client
Berserker66 Oct 3, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
BizHawkClient: Remove outdated sentences in docstrings
  • Loading branch information
Zunawe committed Aug 10, 2023
commit 0929b6cebb589434fe43114be9d6a3626201f8af
8 changes: 2 additions & 6 deletions worlds/AutoBizHawkClient.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ async def validate_rom(self, ctx: BizHawkClientContext) -> bool:
client class, so you do not need to check the system yourself.

Once this function has determined that the ROM should be handled by this client, it should also modify `ctx`
as necessary (such as setting `ctx.game = self.game`, modifying `ctx.items_handling`, etc...). If you can read
the slot name from ROM, set `ctx.auth` here as well. Otherwise the user will be prompted after this."""
as necessary (such as setting `ctx.game = self.game`, modifying `ctx.items_handling`, etc...)."""
...

async def set_auth(self, ctx: BizHawkClientContext) -> None:
Expand All @@ -57,10 +56,7 @@ async def set_auth(self, ctx: BizHawkClientContext) -> None:
@abc.abstractmethod
async def game_watcher(self, ctx: BizHawkClientContext) -> None:
"""Runs on a loop with the approximate interval `ctx.watcher_timeout`. The currently loaded ROM is guaranteed
to have passed your validator when this function is called, and the emulator is very likely to be connected.

Your client is also expected to send `Connect` from here. Make sure you don't send them repeatedly and check the
server connection first."""
to have passed your validator when this function is called, and the emulator is very likely to be connected."""
...

def on_package(self, ctx: BizHawkClientContext, cmd: str, args: dict) -> None:
Expand Down
Loading