An emulator, assembler, and disassembler for the Sega Game Gear
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

10 年之前
10 年之前
10 年之前
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. crater
  2. ======
  3. **crater** is an emulator for the [Sega Game Gear][game gear], with an included
  4. [Z80][z80] assembler/disassembler, written in C.
  5. [game gear]: https://en.wikipedia.org/wiki/Sega_Game_Gear
  6. [z80]: https://en.wikipedia.org/wiki/Zilog_Z80
  7. Why?
  8. ----
  9. While the internet is full of emulators for retro game systems, writing one is
  10. nevertheless a fun learning project.
  11. crater is named after [31 Crateris][crateris], a star that was – for a short
  12. time in 1974 – misidentified as [a moon of Mercury][moon]. Mercury was Sega's
  13. codename for the Game Gear during development.
  14. [crateris]: http://www.astrostudio.org/xhip.php?hip=58587
  15. [moon]: https://en.wikipedia.org/wiki/Mercury%27s_moon
  16. Installing
  17. ----------
  18. Only OS X and Linux are tested. You'll need a modern compiler that supports C11
  19. ([clang][clang] preferred) and [SDL 2][sdl2]. Using Homebrew, you can
  20. `brew install sdl2`; using apt, you can `apt-get install libsdl2-dev`.
  21. Run `make` to create `./crater`. To build the development version with debug
  22. symbols and no optimizations, run `make DEBUG=1`, which creates `./crater-dev`.
  23. crater has a number of test cases. Run the entire suite with `make test`;
  24. individual components can be tested by doing `make test-{component}`, where
  25. `{component}` is one of `cpu`, `vdp`, `psg`, `asm`, `dis`, or `integrate`.
  26. [clang]: http://clang.llvm.org/
  27. [sdl2]: https://www.libsdl.org/
  28. Usage
  29. -----
  30. Running `./crater` without arguments will display a list of ROM images located
  31. in the `roms/` directory, and then ask the user to pick one, or enter their own
  32. ROM path. You can provide a path directly with `./crater path/to/rom`.
  33. Add or symlink ROMs to `roms/` at your leisure. Note that they must end in
  34. `.gg` or `.bin` to be auto-detected.
  35. Add `--fullscreen` (`-f`) to enable fullscreen mode, or `--scale <n>`
  36. (`-s <n>`) to scale the game screen by an integer factor.
  37. Add `--debug` (`-g`) to show logging information while running. Pass it twice
  38. (`-gg`) to show more detailed logs, including an emulator trace.
  39. `./crater -h` gives (fairly basic) command-line usage, and `./crater -v` gives
  40. the current version.
  41. ### Assembler/Disassembler
  42. crater has built-in support for converting Z80 assembly into ROM images, as
  43. well as attempting the reverse process (i.e., disassembling).
  44. `--assemble <input> [<output>]` (`-a`) converts source code into a `.gg` binary
  45. that can be run by crater. `--disassemble <input> [<output>]` (`-d`) executes
  46. the opposite operation. If no output file is given, crater will use the name of
  47. the input file, with the extension replaced with `.gg` for `-a` and `.asm` for
  48. `-d`. By default, this will never overwrite the original filename; pass
  49. `--overwrite` (`-r`) to let crater do so.
  50. Credits
  51. -------
  52. Special thanks to [SMS Power!][sms_power]'s excellent [development][sms_dev]
  53. section, which has been invaluable in figuring out many of the Game Gear's
  54. details, including ROM header structure and the memory mapping system. Various
  55. source code comments reference their pages.
  56. Also thanks to [Thomas Scherrer's Z80 website][scherrer] for many useful
  57. resources about the Game Gear's CPU, including info about
  58. [undocumented opcodes][undoc_ops] and [flags][undoc_flags]. Finally, credit
  59. goes to [ClrHome][clrhome] for their helpful Z80 [instruction table][clrtab].
  60. [sms_power]: http://www.smspower.org/
  61. [sms_dev]: http://www.smspower.org/Development/Index
  62. [scherrer]: http://z80.info/
  63. [undoc_ops]: http://www.z80.info/z80undoc.htm
  64. [undoc_flags]: http://z80.info/z80sflag.htm
  65. [clrhome]: http://clrhome.org/
  66. [clrtab]: http://clrhome.org/table/