/[projet1]/public/pc/tools/osdk/main/Osdk/_final_/Oricutron/ReadMe.txt
Defence Force logotype

Diff of /public/pc/tools/osdk/main/Osdk/_final_/Oricutron/ReadMe.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1117 by dbug, Sun Dec 8 10:50:26 2013 UTC revision 1118 by dbug, Mon Feb 24 19:28:30 2014 UTC
# Line 1  Line 1 
1  Oricutron 0.9  Oricutron 1.1
2  -------------  -------------
3    
4  (c)2009-2012 Peter Gordon (pete@petergordon.org.uk)  (c)2009-2013 Peter Gordon (pete@petergordon.org.uk)
5    
6  This is a work in progress.  This is a work in progress.
7    
8    
9  Current status  Current status
10  ==============  ==============
11    
12    6502:  100% done (apart from any unknown bugs :)    6502:  100% done (apart from any unknown bugs :)
13    VIA:   95% done.    VIA:   95% done.
14    AY:    99% done.    AY:    99% done.
15    Video: 100% done    Video: 100% done
16    Tape:  99% done (.TAP, .ORT and .WAV supported)    Tape:  99% done (.TAP, .ORT and .WAV supported)
17    Disk:  Reading/Writing sectors works. No track read/write.    Disk:  Reading/Writing sectors works. No track read/write.
18    
19  Telestrat emulation is included, but is far from finished and doesn't currently  
20  work well enough to be useful.  
21    Credits
22    =======
23  Credits  
24  =======    Programming
25      -----------
26    Programming  
27    -----------    Peter Gordon
28    
29    Peter Gordon  
30      Additional Programming
31      ----------------------
32    Additional Programming  
33    ----------------------    Francois Revol
34      Alexandre Devert
35    Francois Revol    Stefan Haubenthal
36    Alexandre Devert    Ibisum
37    Stefan Haubenthal    Kamel Biskri
38    Ibisum    Iss
39    Kamel Biskri  
40    
41      Amiga & Windows ports
42    Amiga & Windows ports    ---------------------
43    ---------------------  
44      Peter Gordon
45    Peter Gordon  
46    
47      MacOS X port
48    MacOS X port    ------------
49    ------------  
50      Francois Revol
51    Francois Revol    Kamel Biskri
52    Kamel Biskri  
53    
54      MorphOS & AROS ports
55    MorphOS & AROS port    --------------------
56    -------------------  
57      Stefan Haubenthal
58    Stefan Haubenthal  
59    
60      Linux port
61    Linux port    ----------
62    ----------  
63      Francois Revol
64    Francois Revol    Ibisum
65    Ibisum    Alexandre Devert
66    Alexandre Devert  
67    
68      Pandora port
69    Pandora port    ------------
70    ------------  
71      Ibisum
72    Ibisum  
73      
74      Pravetz disk support
75  Thanks    --------------------
76  ======  
77      Iss
78  Thanks to DBug and Twilighte for letting me distribute their demos and  
79  games with Oricutron.  
80    
81  Thanks to DBug, Twilighte, Chema, kamelito, Yicker, JamesD, Algarbi, ibisum,  
82  jede, thrust26 and everyone else for their help and feedback!  Thanks
83    ======
84    
85    Thanks to DBug and Twilighte for letting me distribute their demos and
86  AVI export notes  games with Oricutron.
87  ================  
88    Thanks to DBug, Twilighte, Chema, kamelito, Yicker, JamesD, Algarbi, ibisum,
89  The AVI export uses the MRLE codec. Your favourite player might not support  jede, thrust26 and everyone else for their help and feedback!
90  it, but MPlayer plays it, ffmpeg converts it and you can upload it directly  
91  to youtube.  
92    
93  Note that the MRLE codec shows up some endian-issues on the Amiga OS4 port  AVI export notes
94  of MPlayer, so it will sound crappy and have wrong colours until those bugs  ================
95  are fixed :-(  
96    The AVI export uses the MRLE codec. Your favourite player might not support
97    it, but MPlayer plays it, ffmpeg converts it and you can upload it directly
98  Command line  to youtube.
99  ============  
100    Note that the MRLE codec shows up some endian-issues on the Amiga OS4 port
101  You can specify certain options on the command line. All options have  of MPlayer, so it will sound crappy and have wrong colours until those bugs
102  both short and long versions. For example:  are fixed :-(
103    
104    -mblah  
105    Command line
106    or  ============
107    
108    --machine blah  You can specify certain options on the command line. All options have
109    both short and long versions. For example:
110  Is the same thing. Note that the short version doesn't have a space, but  
111  the long version does.    -mblah
112    
113  Here are all the options:    or
114    
115      --machine blah
116    -m / --machine    = Specify machine type. Valid types are:  
117    Is the same thing. Note that the short version doesn't have a space, but
118                        "atmos" or "a" for Oric atmos  the long version does.
119                        "oric1" or "1" for Oric-1  
120                        "o16k" for Oric-1 16k  Here are all the options:
121                        "telestrat" or "t" for Telestrat  
122                        "pravetz", "pravetz8d" or "p" for Pravetz 8D  
123      -m / --machine     = Specify machine type. Valid types are:
124    -d / --disk       = Specify a disk image to use in drive 0  
125    -t / --tape       = Specify a tape image to use                         "atmos" or "a" for Oric atmos
126    -k / --drive      = Specify a disk drive controller. Valid types are:                         "oric1" or "1" for Oric-1
127                           "o16k" for Oric-1 16k
128                        "microdisc" or "m" for Microdisc                         "telestrat" or "t" for Telestrat
129                        "jasmin" or "j" for Jasmin                         "pravetz", "pravetz8d" or "p" for Pravetz 8D
130    
131    -s / --symbols    = Load symbols from a file    -d / --disk        = Specify a disk image to use in drive 0
132    -f / --fullscreen = Run oricutron fullscreen    -t / --tape        = Specify a tape image to use
133    -w / --window     = Run oricutron in a window    -k / --drive       = Specify a disk drive controller. Valid types are:
134    -R / --rendermode = Render mode. Valid modes are:  
135                           "microdisc" or "m" for Microdisc
136                        "soft" for software rendering                         "jasmin" or "j" for Jasmin
137                        "opengl" for OpenGL  
138      -s / --symbols     = Load symbols from a file
139    -b / --debug      = Start oricutron in the debugger    -f / --fullscreen  = Run oricutron fullscreen
140    -r / --breakpoint = Set a breakpoint    -w / --window      = Run oricutron in a window
141    -h / --help       = Print command line help and quit    -R / --rendermode  = Render mode. Valid modes are:
142    
143                           "soft" for software rendering
144  Examples:                         "opengl" for OpenGL
145    
146  oricutron --machine atmos --tape "tape files/foo.tap" --symbols "my files/symbols"    -b / --debug       = Start oricutron in the debugger
147  oricutron -m1 -tBUILD/foo.tap -sBUILD/symbols -b    -r / --breakpoint  = Set a breakpoint
148  oricutron --drive microdisc --disk demos/barbitoric.dsk --fullscreen    -h / --help        = Print command line help and quit
149  oricutron -ddemos/barbitoric.dsk -f  
150      --turbotape on|off = Enable or disable turbotape
151      --lightpen on|off  = Enable or disable lightpen
152      --vsynchack on|off = Enable or disable VSync hack
153  Keys    --scanlines on|off = Enable or disable scanline simulation
154  ====  
155    NOTE: If you are not sure what machine or drive type is required for a disk or
156    In emulator  tape image, just pass the filename without any options and Oricutron will
157    -----------  try and autodetect for you.
158    
159    F1       - Bring up the menu  
160    F2       - Go to debugger/monitor  Examples:
161    F3       - Reset button (NMI)  
162    F4       - Hard reset  oricutron tapes/tape_image.tap
163    Shift+F4 - Jasmin reset  oricutron disks/disk_image.dsk
164    F5       - Toggle FPS  oricutron --machine atmos --tape "tape files/foo.tap" --symbols "my files/symbols"
165    F6       - Toggle warp speed  oricutron -m1 -tBUILD/foo.tap -sBUILD/symbols -b
166    F7       - Save all modified disks  oricutron --drive microdisc --disk demos/barbitoric.dsk --fullscreen
167    Shift+F7 - Save all modified disks to new disk images  oricutron -ddemos/barbitoric.dsk -f
168    F9       - Save tape output  oricutron --turbotape off tapes/hobbit.tap
169    F10      - Start/Stop AVI capture  
170    Help     - Show guide  
171    
172    Keys
173    In menus  ====
174    --------  
175      In emulator
176    Cursors   - Navigate    -----------
177    Enter     - Perform option  
178    Backspace - Go back    F1       - Bring up the menu
179    Escape    - Exit menus    F2       - Go to debugger/monitor
180    (or use the mouse)    F3       - Reset button (NMI)
181      F4       - Hard reset
182      Shift+F4 - Jasmin reset
183    In Debugger/Monitor    F5       - Toggle FPS
184    -------------------    F6       - Toggle warp speed
185      F7       - Save all modified disks
186    F2      - Return to the emulator    Shift+F7 - Save all modified disks to new disk images
187    F3      - Toggle console/debug output/memwatch    F9       - Save tape output
188    F4      - Toggle VIA/AY information    F10      - Start/Stop AVI capture
189    F9      - Reset cycle count    Help     - Show guide
190    F10     - Step over code  
191    F11     - Step over code without tracing into  
192              subroutines.    In menus
193    F12     - Skip instruction    --------
194    
195      Cursors   - Navigate
196    In the console:    Enter     - Perform option
197    ---------------    Backspace - Go back
198      Escape    - Exit menus
199    Up/Down - Command history    (or use the mouse)
200    
201    
202    In memwatch:    In Debugger/Monitor
203    ------------    -------------------
204    
205    Up/Down           - Scroll (+shift for page up/down)    F2      - Return to the emulator
206    Page Up/Page Down - Page up/down    F3      - Toggle console/debug output/memwatch
207    Hex digits        - Enter address    F4      - Toggle VIA/AY/disk information
208    S                 - Toggle split mode    F9      - Reset cycle count
209    Tab               - Switch windows in split mode    F10     - Step over code
210      F11     - Step over code without tracing into
211                subroutines.
212  Monitor instructions    F12     - Skip instruction
213  ====================  
214    
215  In the monitor, number arguments are decimal by default, or prefixed with $ for    In the console:
216  hex or % for binary. Pretty much everything is output in hex.    ---------------
217    
218  In most places where you can enter a number or address, you can pass a CPU or    Up/Down - Command history
219  VIA register. (VIA registers are prefixed with V, e.g. VDDRA). Anywhere you can  
220  pass an address, you can also use a symbol.  
221      In memwatch:
222  Commands:    ------------
223    
224    ?                     - Help    Up/Down           - Scroll (+shift for page up/down)
225    a <addr>              - Assemble    Page Up/Page Down - Page up/down
226    bc <bp id>            - Clear breakpoint    Hex digits        - Enter address
227    bcm <bp id>           - Clear mem breakpoint    S                 - Toggle split mode
228    bl                    - List breakpoints    Tab               - Switch windows in split mode
229    blm                   - List mem breakpoints  
230    bs <addr>             - Set breakpoint  
231    bsm <addr> [rwc]      - Set mem breakpoint  Monitor instructions
232    bz                    - Zap breakpoints  ====================
233    bzm                   - Zap mem breakpoints  
234    d <addr>              - Disassemble  In the monitor, number arguments are decimal by default, or prefixed with $ for
235    df <addr> <end> <file>- Disassemble to file  hex or % for binary. Pretty much everything is output in hex.
236    m <addr>              - Dump memory  
237    mm <addr> <value>     - Modify memory  In most places where you can enter a number or address, you can pass a CPU or
238    mw <addr>             - Memory watch at addr  VIA register. (VIA registers are prefixed with V, e.g. VDDRA). Anywhere you can
239    nl <file>             - Load snapshot  pass an address, you can also use a symbol.
240    ns <file>             - Save snapshot  
241    r <reg> <val>         - Set <reg> to <val>  Commands:
242    q, x or qm            - Quit monitor  
243    qe                    - Quit emulator    ?                     - Help
244    sa <name> <addr>      - Add or move user symbol    a <addr>              - Assemble
245    sk <name>             - Kill user symbol    bc <bp id>            - Clear breakpoint
246    sc                    - Symbols not case-sensitive    bcm <bp id>           - Clear mem breakpoint
247    sC                    - Symbols case-sensitive    bl                    - List breakpoints
248    sl <file>             - Load user symbols    blm                   - List mem breakpoints
249    sx <file>             - Export user symbols    bs <addr>             - Set breakpoint
250    sz                    - Zap user symbols    bsm <addr> [rwc]      - Set mem breakpoint
251    wm <addr> <len> <file>- Write mem to disk    bz                    - Zap breakpoints
252      bzm                   - Zap mem breakpoints
253      d <addr>              - Disassemble
254      df <addr> <end> <file>- Disassemble to file
255  Breakpoints    m <addr>              - Dump memory
256  ===========    mm <addr> <value>     - Modify memory
257      mw <addr>             - Memory watch at addr
258  There are two types of breakpoints. "Normal" breakpoints trigger when the CPU    nl <file>             - Load snapshot
259  is about to execute an instruction at the breakpoint address. "Memory" breakpoints    ns <file>             - Save snapshot
260  trigger when the breakpoint address is accessed or modified.    r <reg> <val>         - Set <reg> to <val>
261      q, x or qm            - Quit monitor
262  There are three ways a memory breakpoint can be triggered; when the CPU is about    qe                    - Quit emulator
263  to read the address (r), and the CPU is about to write the address (w), or after the    sa <name> <addr>      - Add or move user symbol
264  value at the address changes for any reason (c).    sk <name>             - Kill user symbol
265      sc                    - Symbols not case-sensitive
266  You specify which ways you'd like the breakpoint to trigger when you set the memory    sC                    - Symbols case-sensitive
267  breakpoint:    sl <file>             - Load user symbols
268      sx <file>             - Export user symbols
269  bsm r $0c00        <-- Break when the CPU is about to read from $0c00    sz                    - Zap user symbols
270  bsm rw $0c00       <-- Break when the CPU is about to access $0c00    wm <addr> <len> <file>- Write mem to disk
271  bsm c $0c00        <-- Break after then contents of $0c00 change  
272  bsm rwc $0c00      <-- Break just before the CPU accesses $0c00, or just after it  
273                         changes for any reason.  
274    Breakpoints
275    ===========
276    
277    There are two types of breakpoints. "Normal" breakpoints trigger when the CPU
278    is about to execute an instruction at the breakpoint address. "Memory" breakpoints
279    trigger when the breakpoint address is accessed or modified.
280    
281    There are three ways a memory breakpoint can be triggered; when the CPU is about
282    to read the address (r), and the CPU is about to write the address (w), or after the
283    value at the address changes for any reason (c).
284    
285    You specify which ways you'd like the breakpoint to trigger when you set the memory
286    breakpoint:
287    
288    bsm r $0c00        <-- Break when the CPU is about to read from $0c00
289    bsm rw $0c00       <-- Break when the CPU is about to access $0c00
290    bsm c $0c00        <-- Break after then contents of $0c00 change
291    bsm rwc $0c00      <-- Break just before the CPU accesses $0c00, or just after it
292                           changes for any reason.

Legend:
Removed from v.1117  
changed lines
  Added in v.1118

  ViewVC Help
Powered by ViewVC 1.1.26