TASEmulators / TASEmulators/BizHawk

[Feature req.] Expose cheats/freezes API

Open
#2,721 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

App: EmuHawk re: APIHawk re: Lua API/scripting Request: Feature/Enhancement
Dominant language
C#
Stars
2.8k
Forks
468
PR merge metrics
No merged PRs in 30d

Description

Whenever this has come up, someone says the internal API isn't stable enough to expose.

edit: In #3889, GPGX gained a dedicated "deep freeze" API. We decided to get that merged, since it was in a functional state, and worry about creating an IEmulatorService for it later.

edit 2: There's an existing hack
https://github.com/TASEmulators/BizHawk/blob/6b06d50085a1643815039a62dfade71e62d8be62/src/BizHawk.Client.Common/tools/Cheat.cs#L184-L196
...referring to MemoryDomainDelegateSysBusNES, which indeed is only used in NesHawk.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing hack in src/BizHawk.Client.Common/tools/Cheat.cs, especially the referenced lines, and trace how it uses MemoryDomainDelegateSysBusNES in NesHawk. Review the decision around GPGX's deep freeze API in #3889 and determine the scope of a stable cheats/freezes API. Done should include an agreed API design rather than an ad hoc internal reference.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
game-dev, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.