TeamREPENTOGON / TeamREPENTOGON/REPENTOGON

Means of determining if a vanilla resource file has been replaced by another mod

Open
#910 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

non-callback-request
Dominant language
C++
Stars
345
Forks
51
Avg merge
11h 2m
Merged PRs (30d)
4

Description

I'm trying to implement logic for syncing game events to the currently playing music. If a vanilla music track gets replaced by another mod however, the sync is no longer appropriate. Currently there are means of detecting if a music track has been replaced via XML, but not if the OGG music file has been replaced directly.

Something along the lines of Isaac.IsResourceFileReplaced("music/ambush.ogg") would be sufficient for my use case. Perhaps something like Isaac.GetResourceFileMod("music/ambush.ogg") -- returning what mod has replaced the file, if any -- would be more generally practical.

Contributor guide

No contributing guide indexed for this repository

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 tracing the existing XML-based music replacement detection and the resource-loading path for music/ambush.ogg. Determine how direct OGG replacements are represented and whether the API should report only replacement status or the replacing mod. Done means a documented API can reliably distinguish vanilla music from directly replaced music files.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
game-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.