Mercurial > repos > blastem

comparison README @ 808:2953708d02af

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update README, CHANGELOG and version string for 0.3.1
author Michael Pavone <pavone@retrodev.com>
date Sun, 26 Jul 2015 19:36:33 -0700
parents 0e5f14d9a579
children 1f75614d7be8
comparison
equal deleted inserted replaced
807:9cba2069e2ff 808:2953708d02af
1 BlastEm 0.3.0 1 BlastEm 0.3.1
2 ------------- 2 -------------
3 3
4 Installation 4 Installation
5 ------------ 5 ------------
6 6
7 Extract this tarball to a directory of your choosing. If you wish to change the 7 Extract this archive to a directory of your choosing. If you wish to change the
8 configuration settings, copy default.cfg to ~/.config/blastem/blastem.cfg and 8 configuration settings, copy default.cfg to $HOME/.config/blastem/blastem.cfg and
9 modify the copy. You may also whish to add the blastem directory to your PATH 9 modify the copy. You may also whish to add the blastem directory to your PATH
10 environment variable. 10 environment variable.
11
12 Usage
13 -----
14
15 BlastEm does not have much of a GUI at the moment and expects a filename to be
16 passed to it at startup. You can do this by either running it from the command
17 line or associating it with a file type. To get a list of supported command
18 line options on Linux or OSX type:
19
20 ./blastem -h
21
22 From within your BlastEm directory. On Windows type:
23
24 blastem.exe -h
11 25
12 Configuration 26 Configuration
13 ------------- 27 -------------
14 28
15 Configuration is read from the file at ~/.config/blastem/blastem.cfg if it 29 Configuration is read from the file at $HOME/.config/blastem/blastem.cfg if it
16 exists othwerise it is read from default.cfg from the same directory as the 30 exists, othwerise it is read from default.cfg from the same directory as the
17 blastem executable. Sections are denoted by a section name followed by an open 31 BlastEm executable. Sections are denoted by a section name followed by an open
18 curly bracket, the section's contents and a closing curly bracket. Individual 32 curly bracket, the section's contents and a closing curly bracket. Individual
19 configuration values are set by entering the value's name followed by a space 33 configuration values are set by entering the value's name followed by a space
20 or tab and followed by the desired value. 34 or tab and followed by the desired value.
21 35
22 Bindings 36 Bindings
63 n - Advance to next instruction 77 n - Advance to next instruction
64 o - Advance to next instruction ignoring branches to 78 o - Advance to next instruction ignoring branches to
65 lower addresses (good for breaking out of loops) 79 lower addresses (good for breaking out of loops)
66 s - Advance to next instruction (follows bsr/jsr) 80 s - Advance to next instruction (follows bsr/jsr)
67 c - Continue 81 c - Continue
82 bt - Print a backtrace
68 p[/(x|X|d|c)] VALUE - Print a register or memory location 83 p[/(x|X|d|c)] VALUE - Print a register or memory location
69 vs - Print VDP sprite list 84 vs - Print VDP sprite list
70 vr - Print VDP register info 85 vr - Print VDP register info
71 zb ADDRESS - Set a Z80 breakpoint 86 zb ADDRESS - Set a Z80 breakpoint
72 zp[/(x|X|d|c)] VALUE - Display a Z80 value 87 zp[/(x|X|d|c)] VALUE - Display a Z80 value
81 di[/(x|X|d|c)] VALUE - Print VALUE before every debugger prompt 96 di[/(x|X|d|c)] VALUE - Print VALUE before every debugger prompt
82 q - Quit BlastEm 97 q - Quit BlastEm
83 98
84 The -d flag can be used to cause BlastEm to start in the debugger. 99 The -d flag can be used to cause BlastEm to start in the debugger.
85 Alternatively, you can use the ui.enter_debugger action (mapped to the 'u' key 100 Alternatively, you can use the ui.enter_debugger action (mapped to the 'u' key
86 by default)to enter the debugger while a game is running. 101 by default) to enter the debugger while a game is running.
87 102
88 GDB Remote Debugging 103 GDB Remote Debugging
89 -------------------- 104 --------------------
90 105
91 In addition to the native debugger, BlastEm can also act as a GDB remote 106 In addition to the native debugger, BlastEm can also act as a GDB remote
98 where BLASTEM_PATH is the relative or absolute path to your BlastEm 113 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. 114 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 115 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. 116 control to GDB. This will allow you to set breakpoints before your code runs.
102 117
118 On Windows, the procedure is slightly different. First run
119 blastem.exe ROM_FILE.bin -D
120 This will cause BlastEm to wait for a socket connection on port 1234. It will
121 appear to be frozen until gdb connects to it. Now open the ELF file in gdb
122 and type:
123
124 target remote :1234
125
103 Trace points and watch points are not currently supported. 126 Trace points and watch points are not currently supported.
104 127
105 License 128 License
106 ------- 129 -------
107 130