{"id":17786772,"url":"https://github.com/hertzdevil/mm5sound","last_synced_at":"2025-04-01T23:46:49.721Z","repository":{"id":91466251,"uuid":"82425314","full_name":"HertzDevil/mm5sound","owner":"HertzDevil","description":"C++ translation of the Mega Man 5 sound engine","archived":false,"fork":false,"pushed_at":"2017-03-01T15:30:53.000Z","size":135,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-07T15:35:22.863Z","etag":null,"topics":["chiptune","megaman","reverse-engineering"],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HertzDevil.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-19T00:37:53.000Z","updated_at":"2022-07-24T02:01:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"d4cb2b50-5ca9-4daa-a4eb-136e1ab3365a","html_url":"https://github.com/HertzDevil/mm5sound","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HertzDevil%2Fmm5sound","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HertzDevil%2Fmm5sound/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HertzDevil%2Fmm5sound/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HertzDevil%2Fmm5sound/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HertzDevil","download_url":"https://codeload.github.com/HertzDevil/mm5sound/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246730262,"owners_count":20824396,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chiptune","megaman","reverse-engineering"],"created_at":"2024-10-27T10:08:26.361Z","updated_at":"2025-04-01T23:46:49.712Z","avatar_url":"https://github.com/HertzDevil.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mm5sound\r\n\r\nThis repository is an attempt to translate an ancient 6502 assembly sound driver from Mega Man 5 into modern C++, so that I could use this to teach people a thing or two. Will it succeed!?\r\n\r\nThe source code does not have to be capable of producing / compiling data in the original form at all, but ROM addresses will be placed near relevant constructs for reference. **This cannot be used to compile music for Mega Man 5**, use [MGCInts](http://github.com/HertzDevil/MGCInts) instead (once I extend the `mm3` engine support).\r\n\r\n### Testing\r\n\r\nAssuming `Megaman V (U) [!].nes` is available as `mm5.nes` in the same directory, this produces a register write log which can be directly diffed against log files generated by NSFPlay:\r\n\r\n```\r\n$ make\r\n$ ./mm5test \u003e output.log\r\n```\r\n\r\nROM images will no longer be required once there is a music data representation within C++.\r\n\r\nTo check the correctness of the sound driver:\r\n\r\n- Log **all 76** songs from the Mega Man 5 NSF (containing all sound effects, this does not use the 24-song music-only version) from NSFPlay using `LOG_CPU=1 LOG_CPU_FILE=nsf_write.log`, so that each song is played for at least 3 minutes.\r\n- Run `logs/splitter.lua` from the root directory, which prepares individual logs for each song. The original log can be removed.\r\n- Run `logs/verify.lua`.\r\n\r\n### Roadmap\r\n\r\n- [x] Finish all code (manually)\r\n- [x] Verify all music and sound effects are correct\r\n- [ ] Music data classes (best make them entirely `constexpr` for extra challenge)\r\n- [ ] Auxiliary classes that make it look more like \"good\" C++ ~~and less like FamiTracker~~\r\n- [ ] Remove the NES memory model\r\n- [ ] Add documentation and pictures\r\n- [ ] Fully annotated disassembly\r\n\r\n### License\r\n\r\nMIT License.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhertzdevil%2Fmm5sound","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhertzdevil%2Fmm5sound","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhertzdevil%2Fmm5sound/lists"}