Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonas Rinke committed Jun 13, 2019
1 parent 88ec290 commit 8c58027
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# VRC7-Sound

Emulator for the expansion sound of the Konami VRC7.

## About

VRC7-Sound is an open-source emulator for the Konami VRC7's expansion sound, featured in the Famicom game *Lagrange Point*.
The VRC7 enables FM-style music through the use of a modified Yamaha YM2413 (OPLL) architecture, which is itself based on the
YM3812, a chip prominently used in the AdLib and Sound Blaster soundcards. The emulator attempts to accurately recreate this sound
by relying mostly on information gathered from the VRC7's die shot.

## Usage

To use VRC7-Sound, simply embed the source files into your C/C++ project. No additional libraries are required. Detailed
description of how to use the emulator and it's specific functions are given in the header file (vrc7_sound.h).

## Contact
Questions? Feedback? Bugs? Let me know:

Jonas Rinke (Delphi1024)
delphi1024 (аt) gmail (dоt) com

## References
* VRC7 die shot by digshadow:
* https://siliconpr0n.org/archive/doku.php?id=digshadow:konami:vrc_vii_053982

* YM2413 (OPLL) Datasheet:
* http://www.smspower.org/maxim/Documents/YM2413ApplicationManual

* VRC7 audio on Nesdev Wiki:
* https://wiki.nesdev.com/w/index.php/VRC7_audio

* OPLx logSin/exp/ksl tables by Olli Niemitalo and Matthew Gambrell:
* http://yehar.com/blog/?p=665
* https://docs.google.com/document/d/18IGx18NQY_Q1PJVZ-bHywao9bhsDoAqoIn1rIm42nwo/edit

* Instrument ROM Dump by NukeYKT:
* https://siliconpr0n.org/archive/doku.php?id=vendor:yamaha:opl2#ym2413_instruments

* Lagrange point filter analysis by kevtris:
* http://forums.nesdev.com/viewtopic.php?t=4709&p=41523
2 changes: 1 addition & 1 deletion demo/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Demo Recordings

These recordings were made using [NSFPlay 2.4] (https://github.com/bbbradsmith/nsfplay), by modifying nes_vrc7.cpp and nes_vrc7.h
These recordings were made using [NSFPlay 2.4](https://github.com/bbbradsmith/nsfplay), by modifying nes_vrc7.cpp and nes_vrc7.h
to use the VRC7-Sound emulator. Apart from the fade out, no modifications were done to the recordings.

0 comments on commit 8c58027

Please sign in to comment.