TASEmulators / TASEmulators/BizHawk

Extract movie parsers to separate library

Open
#3,572 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Meta Open to design proposals only re: Movie importers Request: Feature/Enhancement
Dominant language
C#
Stars
2.8k
Forks
468
PR merge metrics
No merged PRs in 30d

Description

To share code with TASVideos.org (see TASVideos/tasvideos#1529) and maybe some other emulators like TriCNES.

  • I understand adelikat has a personal-use app for triaging submissions which includes another set of parser implementations in C#.

Besides the .bk2 parser, which is the reference implementation, the rest currently skip reconstructing the model and just convert straight to a Bk2Movie object. Many of the parsers are also missing features that were deemed unnecessary for the purpose of converting to .bk2 and resyncing.

Before starting on this, make sure you've familiarised yourself with both BizHawk's and TASVideos.org's parsers (and Bk2Exporter), and take the best of each.

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 by reviewing BizHawk’s existing movie parsers, TASVideos.org’s parsers, and the Bk2Exporter reference. Compare the .bk2 parser with the other formats, including model reconstruction and omitted features. Done means the parsers are extracted into a separate reusable library with the needed behavior preserved.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.