Skip to content

Commit

Permalink
Update Readme for Hollyhock
Browse files Browse the repository at this point in the history
  • Loading branch information
diddyholz committed Jan 6, 2022
1 parent 43883ac commit e0d34e1
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,33 @@ Since the CAS has a rather slow processor, a high speed emulator core is mandato

## Getting Started

The SDK used by the emulator and the CFW necessary to run it, is not public at the moment. Therefore it is currently not possible for you to use this emulator.
You will need to have the [Hollyhock-2 CFW](https://github.com/SnailMath/hollyhock-2/) installed. After that just copy the most recent CPBoy.hkk from the releases tab into the root directory of your calculator.

As soon as the SDK and custom firmware have reached a usable state, I will make them public and update this section with an installation tutorial.
Currently there is no UI to select the rom. To load your Gameboy ROM, also copy it to the root directory of your calculator and call it "rom.gb".


## Controls

| Calculator key | GB key |
| -------------- | ------ |
| EXE | A |
| + | B |
| SHIFT | SELECT |
| CLEAR | START |
| UP | UP |
| DOWN | DOWN |
| LEFT | LEFT |
| RIGHT | RIGHT |

**MISC:**
- SHIFT + CLEAR: Exit emulator
- KEYBOARD: Toggle frameskipping (When enabled, only render every second frame, which speeds up the emulator a bit but lowers its FPS)
- BACKSPACE: Enable Interlacing (When enabled, only render every second line and switch every frame, which speeds up the emulator a bit but makes visuals worse)


## Building

If you want to build the emulator from source you will need the [Hollyhock-2 SDK](https://github.com/SnailMath/hollyhock-2/). Then, run ´make hhk´ in your terminal to build it. Make sure to build the .hhk file and not the .bin file because the .bin file causes the emulator to freeze and makes the CPU of the calculator behave weirdly (I have absolutely no idea why that happens).


## License
Expand Down

0 comments on commit e0d34e1

Please sign in to comment.