famicom-pro-action-rocky/README.md

Famicom Pro Action Rocky decoder/encoder

# famicom-pro-action-rocky

Nintendo Famicom Pro Action Rocky decoder/encoder (npmjs module)

The Rocky is a device similar to the Game Genie (see also related module:
[nes-game-genie](https://github.com/satoshinm/nes-game-genie)), but it always
includes a compare value and uses a different encoding format.

Largely based on [http://www.chrismcovell.com/CheatConverter.html](http://www.chrismcovell.com/CheatConverter.html), credit to
Blue Hawk, Chris Covell, Jamethiel, ReaperSMS, Quietust, blargg, and others
who have helped decode this format and write the initial encoding/decoding
implementations.

Example:

```js
const { decodeRocky, encodeRocky, isRockyCode } = require('famicom-pro-action-rocky');

console.log(decodeRocky('FCBDD274')); // { address: 0x0000, key: 0x00, value: 0x00 }
console.log(decodeRocky('00000000')); // { address: 0x65da, key: 0xd4, value: 0x3f }

console.log(encodeRocky(0x0000, 0x00, 0x00)); // 'FCBDD274'
console.log(encodeRocky(0x65da, 0x3f, 0xd4)); // '00000000'

console.log(isRockyCode('FCBDD274')); // true
```

For the purposes of this module, Rocky codes must always be exactly 8 uppercase hex digits.

## License

MIT