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

Add documentation for the scripting RPC server #718

Open
1 task done
wrybyte opened this issue Mar 18, 2025 · 0 comments
Open
1 task done

Add documentation for the scripting RPC server #718

wrybyte opened this issue Mar 18, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@wrybyte
Copy link
Contributor

wrybyte commented Mar 18, 2025

Is there an existing issue for this?

  • I have searched the existing issues

What feature are you suggesting?

When a game starts running, the emulator opens a UDP socket which acts as an RPC server. This server can communicate with third-party programs to aid scripting with minimal set-up.

Currently, the emulator supports two request types for reading and writing memory (and there is an open PR (#375, #601) for adding key-press and signal request types as well).

However, virtually none of this information is documented anywhere, and the only reference for how to properly interact with the RPC server is an undocumented Python client that hasn't been updated in six years.

Why would this feature be useful?

It would be great for the RPC server to be expanded even further, but there is hardly any grounds for it to be usable or maintainable.

There is a lot of potential that this feature can have for scripting, but it is hardly useful if nobody knows how to use it (or that it even exists).

I've already written some documentation that I plan to create a PR for, but I thought it was best to create an issue first.

@wrybyte wrybyte added the enhancement New feature or request label Mar 18, 2025
@OpenSauce04 OpenSauce04 added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants