Mercurial > repos > blastem

comparison README @ 468:949c7d875693 v0.1.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added README file
author Mike Pavone <pavone@retrodev.com>
date Wed, 11 Sep 2013 00:08:33 -0700
parents
children 69cfdc81a87c
comparison
equal deleted inserted replaced
467:140af5509ce7 468:949c7d875693
1 BlastEm 0.1.0
2 -------------
3
4 Installation
5 ------------
6
7 Extract this tarball to a directory of your choosing. If you wish to change the
8 configuration settings, copy default.cfg to ~/.config/blastem/blastem.cfg and
9 modify the copy. You may also whish to add the blastem directory to your PATH
10 environment variable.
11
12 Configuration
13 -------------
14
15 Configuration is read from the file at ~/.config/blastem/blastem.cfg if it
16 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
18 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
20 or tab and followed by the desired value.
21
22 Bindings
23 --------
24
25 The keys subsection of bindings maps keyboard keys to gamepad buttons or UI
26 actions. The key name goes on the left and the action is on the right.
27 Most keys are named for the character they produce when pressed. Additionally,
28 the arrow, enter and escape keys have the symbolic names up, down, left, right,
29 enter and esc respectively. Other keys that do not produce characters are not
30 yet supported.
31
32 The pads subsection is used to map gamepads and joysticks. Analog axes are not
33 currently supported. An example configuration is provided in default.cfg to map
34 SDL joystick 0 to the second controller.
35
36 Video
37 -----
38
39 Currently the only setting in the video section is "width", which is the width
40 of the window in pixels. Height is calculated from this value. Both width and
41 height can be overridden from the command line.
42
43 Audio
44 -----
45
46 The audio section has two config values: rate and buffer. rate selects the
47 sample rate and buffer sets the size of the output buffer in samples. 512 is
48 generally a good value, but if you're experiencing audio dropouts you might
49 want to increase it to 1024.
50
51 Debugger
52 --------
53
54 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
56 68K debugger are:
57 b ADDRESS - Set a breakpoint at ADDRESS
58 a ADDRESS - Advance to address
59 n - Advance to next instruction
60 c - Continue
61 p[/(x|X|d|c)] VALUE - Print a register or memory location
62 vs - Print VDP sprite list
63 vr - Print VDP register info
64 zb - Set a Z80 breakpoint
65 q - Quit BlastEm
66 Available commands in the Z80 debugger are:
67 b ADDRESS - Set a breakpoint at ADDRESS
68 a ADDRESS - Advance to address
69 n - Advance to next instruction
70 c - Continue
71 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
73 de BREAKPOINT - Delete a Z80 breakpoint
74 q - Quit BlastEm
75
76 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
78 by default)to enter the debugger while a game is running.
79
80 License
81 -------
82
83 BlastEm is free software distributed under the terms of the GNU General Public
84 License version 3 or higher. This gives you the right to redistribute and/or
85 modify the program as long as you follow the terms of the license. See the file
86 COPYING for full license details.
87