Mercurial > repos > blastem
comparison README @ 536:69cfdc81a87c
Update README
author | Mike Pavone <pavone@retrodev.com> |
---|---|
date | Thu, 13 Feb 2014 01:21:02 -0800 |
parents | 949c7d875693 |
children | 0e5f14d9a579 |
comparison
equal
deleted
inserted
replaced
535:aaa77e351c24 | 536:69cfdc81a87c |
---|---|
1 BlastEm 0.1.0 | 1 BlastEm 0.2.0 |
2 ------------- | 2 ------------- |
3 | 3 |
4 Installation | 4 Installation |
5 ------------ | 5 ------------ |
6 | 6 |
34 SDL joystick 0 to the second controller. | 34 SDL joystick 0 to the second controller. |
35 | 35 |
36 Video | 36 Video |
37 ----- | 37 ----- |
38 | 38 |
39 Currently the only setting in the video section is "width", which is the width | 39 The video section currently has three settings: "width", "vertex_shader" and |
40 of the window in pixels. Height is calculated from this value. Both width and | 40 "fragment_shader". "width" sets the width of the window in pixels. Height is |
41 height can be overridden from the command line. | 41 calculated from this value. Both width and height can be overridden from the |
42 command line. "vertex_shader" and "fragment_shader" control which GLSL shader | |
43 files are used for rendering the display when in Open GL rendering mode. | |
44 Shaders can be used to implement graphical filters and other effects. | |
42 | 45 |
43 Audio | 46 Audio |
44 ----- | 47 ----- |
45 | 48 |
46 The audio section has two config values: rate and buffer. rate selects the | 49 The audio section has two config values: rate and buffer. rate selects the |
53 | 56 |
54 BlastEm has an integrated command-line debugger loosely based on GDB's | 57 BlastEm has an integrated command-line debugger loosely based on GDB's |
55 interface. The interface is very rough at the moment. Available commands in the | 58 interface. The interface is very rough at the moment. Available commands in the |
56 68K debugger are: | 59 68K debugger are: |
57 b ADDRESS - Set a breakpoint at ADDRESS | 60 b ADDRESS - Set a breakpoint at ADDRESS |
61 d BREAKPOINT - Delete a 68K breakpoint | |
58 a ADDRESS - Advance to address | 62 a ADDRESS - Advance to address |
59 n - Advance to next instruction | 63 n - Advance to next instruction |
64 o - Advance to next instruction ignoring branches to | |
65 lower addresses (good for breaking out of loops) | |
66 s - Advance to next instruction (follows bsr/jsr) | |
60 c - Continue | 67 c - Continue |
61 p[/(x|X|d|c)] VALUE - Print a register or memory location | 68 p[/(x|X|d|c)] VALUE - Print a register or memory location |
62 vs - Print VDP sprite list | 69 vs - Print VDP sprite list |
63 vr - Print VDP register info | 70 vr - Print VDP register info |
64 zb - Set a Z80 breakpoint | 71 zb ADDRESS - Set a Z80 breakpoint |
72 zp[/(x|X|d|c)] VALUE - Display a Z80 value | |
65 q - Quit BlastEm | 73 q - Quit BlastEm |
66 Available commands in the Z80 debugger are: | 74 Available commands in the Z80 debugger are: |
67 b ADDRESS - Set a breakpoint at ADDRESS | 75 b ADDRESS - Set a breakpoint at ADDRESS |
68 a ADDRESS - Advance to address | 76 de BREAKPOINT - Delete a Z80 breakpoint |
77 a ADDRESS - Advance to address | |
69 n - Advance to next instruction | 78 n - Advance to next instruction |
70 c - Continue | 79 c - Continue |
71 p[/(x|X|d|c)] VALUE - Print a register or memory location | 80 p[/(x|X|d|c)] VALUE - Print a register or memory location |
72 di[/(x|X|d|c)] VALUE - Print VALUE before every debugger prompt | 81 di[/(x|X|d|c)] VALUE - Print VALUE before every debugger prompt |
73 de BREAKPOINT - Delete a Z80 breakpoint | |
74 q - Quit BlastEm | 82 q - Quit BlastEm |
75 | 83 |
76 The -d flag can be used to cause BlastEm to start in the debugger. | 84 The -d flag can be used to cause BlastEm to start in the debugger. |
77 Alternatively, you can use the ui.enter_debugger action (mapped to the 'u' key | 85 Alternatively, you can use the ui.enter_debugger action (mapped to the 'u' key |
78 by default)to enter the debugger while a game is running. | 86 by default)to enter the debugger while a game is running. |
87 | |
88 GDB Remote Debugging | |
89 -------------------- | |
90 | |
91 In addition to the native debugger, BlastEm can also act as a GDB remote | |
92 debugging stub. To use this, you'll want to configure your Makefile to produce | |
93 both an ELF executable and a raw binary. Invoke an m68k-elf targeted gdb with | |
94 the ELF file. Once inside the gdb session, type: | |
95 | |
96 target remote | BLASTEM_PATH/blastem ROM_FILE.bin -D | |
97 | |
98 where BLASTEM_PATH is the relative or absolute path to your BlastEm | |
99 installation and ROM_FILE.bin is the name of the raw binary for your program. | |
100 BlastEm will halt at the beginning of your program's entry point and return | |
101 control to GDB. This will allow you to set breakpoints before your code runs. | |
102 | |
103 Trace points and watch points are not currently supported. | |
79 | 104 |
80 License | 105 License |
81 ------- | 106 ------- |
82 | 107 |
83 BlastEm is free software distributed under the terms of the GNU General Public | 108 BlastEm is free software distributed under the terms of the GNU General Public |