From f431c850c13dc27cb9adf40ffee1eef049f9c21a Mon Sep 17 00:00:00 2001 From: stephena Date: Tue, 6 Jan 2009 17:01:55 +0000 Subject: [PATCH] More updates to the documentation. I think I'll have to move to a multi-page HTML document, as the current one is getting too unwieldy. git-svn-id: svn://svn.code.sf.net/p/stella/code/trunk@1602 8b62c5a3-ac7e-4cc8-8f21-d9a121418aba --- stella/docs/graphics/developer_stats.png | Bin 0 -> 3995 bytes stella/docs/index.html | 136 ++++++++++++++++++----- 2 files changed, 107 insertions(+), 29 deletions(-) create mode 100644 stella/docs/graphics/developer_stats.png diff --git a/stella/docs/graphics/developer_stats.png b/stella/docs/graphics/developer_stats.png new file mode 100644 index 0000000000000000000000000000000000000000..94bc99e3ac9dfbf0e1d779647d7450114d843ab1 GIT binary patch literal 3995 zcmd52nJ;XaGQWQAqen=9-&n0O%ZbcHDj7Y>KE0cg4U1LXO$I zMC|+!pJo2#hu2U(t6KKeeZOa|H|EpNPtu)lA~v|5(QQSsN2rv`eW5%;`r zZTs8j{qYDB-i?m%i7-KZB#TgLxhtqUKd*eRpvp2L)XE@m6#)N`9u{c<5bT9826k&8 zU0__F%72GeWf*ySHZ|RcBL3>)Enu*!k6GyvvBHes0?v{rhP$s778W-4nO~jS!5ZTG zGzGk-lp*+I4CSa8V=Rkf-^Az(;B#CJRN^;41!Ca%4 ztwuvw#cqO-{fHDE1ZdWIB#<3bioM9%N{s!fH7hQgYTGNX5}MK{Wh=qJIf3R_u#`$_ zKaS=mUGsJb)nAf$rzjvz2^gwR#8G9yRDURc-&I)kS6GF9dc?W z$v4JbXOPom5|a>@_W&((Ck}D=hy0*we_O-O+$|j+AV6Eu6JYh1o9(EmssRM>EZj}d zDE$VTF{+>{2fr$+st9j9NDQ~-FYZMT=wXdsOe!~ zl3cvw&_nbWOvRY-`4* zv&0gx=J<`k3LMbjpybM+XJ~of)U{5-+>AOZq#{+6{xd=y;oX2@eZEcX|gxL zP95-vC)Yn`JjxyQbTK~#Cjo{#a{#Yodr1Amiu--vrR>yo)jC2}e^9dZg8i}aR^f5O zRb2_Y&Uh5~ut0VT26RR{bh58*ps%~pqAe4GIft)=BFCPDi#`G?Tl%5g8%TIgT=^{{-vSV*LCrTs zeZEyosvW#M-w~$qx8Oe?L(kV{x`&Jozd%x`3c!5iK=2 zBF?zLXz4F8|HV@jqI7ZBF8a7yJd6Rjuv}Fxq|Un();(e!Ih~q*2FL18U}mT4MiK`af>#tc6-1yYW{BVkdMz# z1@^s&;7)0x!@{Rdy;xgYr&i*iHZOfOQ~~~%7@a-z`F`AilVS8G+r=3NyDYuM;GV-L zs*X(a8!Gvs?hiYobd8d2HDWeJnO5d;a9X-Ja#S}Sv$zal6#U5ByD zd5p2Yey~;8XyX31>a&f;D z^Cie|Twt?RAzivH(JL6wxvge*y)81)!eW5e`!iMy$9zBYhG?+6w{Cqy-HH zAEP5hk1kU^CDWjK_IJS>PYz>HLu(x{!k2U^J$fugnGudif! zM_t5TUsB>nrWl)O^D>~q;}4eQNm;8yjo6unF((=;18G8cf1IGz}OKLR5kr& z!_N*yumu-PuFmPd+=R=q(a3oFx9se76KQ!<&a)<0gAb+^D;LPNOzR~UFJGzNH1OWA ztPCH4@Ss-Sv(Z3Jo)&5C`@4X3ZD9t#fg4K!lLn_CYq|L0q_#2l2LGLm%`EEs3)ZnT zBgykOa^hYDpgmPiA4b(mX;1BCSexLR?^PzO?yEn-I@ca9AJ6XFl&oczpfV2HSM)j^ zp2>nXj6q&9X~sNSfiaq~Q|I8bs&f zp~nhKv8V8ay#vx`Q|nUhnWx7xJ0&Y47U4KnSRBJVF@huqpb5^?k`4{+rB_E&&o%UL z^xb`Ns-&w=mV^q*@dRp6`Q0c{>->m;JA3Cu?!!EV;-E}U`$ai7{Xx{7l2D^viIV=f z*6p*Amrj7~&8o$MA2(_nfBo-9KTkvZBuC-FymxpGCd7?KoJ5}8sK?V$@t^?H;FR0u zi4G`=i6`u&=Cn>@c0NC_h$xm0zvMM^<+ui*T!h$!IwQVSVt0DxsGx29HvIh+HNIE| zvA%0xD!;idXaIZF!Id(HjVxHV=uKFnfE$#9A06!CoAl%qROM Audit Mode
  • Stelladaptor Support
  • AtariVox/SaveKey Support
    • -
  • Integrated Debugger
    • +
  • Developer Options/Integrated Debugger
  • Settings File
  • Cheatcode Manager
  • Game Properties
    • @@ -777,11 +777,6 @@ snapshot in unscaled mode. - - 
    -stats <0|1>
    - Overlay console info on the TIA image during emulation. - - 
    -listrominfo
    Prints relevant contents of the Stella ROM database, one ROM per line, @@ -849,11 +844,6 @@ Set the full pathname of the ROM properties file. - - 
    -tiafloat <1|0>
    - Set unused TIA pins to be floating on a read/peek. - - 
    -avoxport <name>
    Set the name of the serial port where an AtariVox is connected. @@ -905,7 +895,17 @@ 
    -holdbutton0
    Start the emulator with the left joystick button held down. - + + + 
    -stats <1|0>
    + Overlay console info on the TIA image during emulation. + + + + 
    -tiafloat <1|0>
    + Set unused TIA pins to be floating on a read/peek. + + 
    -bs <type>
    Set "Cartridge.Type" property. See the Game Properties section @@ -1619,6 +1619,60 @@ Control + PageDown Cmd + PageDown + + + Toggle frame stats (scanline count/fps/bs type/etc) + Alt + l + Shift-Cmd + l + + + + Toggle TIA Player0 object + Alt + z + Shift-Cmd + z + + + + Toggle TIA Player1 object + Alt + x + Shift-Cmd + x + + + + Toggle TIA Missile0 object + Alt + c + Shift-Cmd + c + + + + Toggle TIA Missile1 object + Alt + v + Shift-Cmd + v + + + + Toggle TIA Ball object + Alt + b + Shift-Cmd + b + + + + Toggle TIA Playfield object + Alt + n + Shift-Cmd + n + + + + Turn all TIA objects off + Alt + . + Shift-Cmd + . + + + + Turn all TIA objects on + Alt + / + Shift-Cmd + / +

    Other Keys (cannot be remapped, except those marked with '*')

    @@ -1648,13 +1702,6 @@ Cmd + Enter - Decrease volume (*) Alt + [ @@ -1744,12 +1791,6 @@ Control + l Cmd + l - - - Toggle frame stats (scanline count/fps/bs type/etc) - Alt + l - Shift-Cmd + l - @@ -2029,14 +2070,51 @@ -
    +

    - 13. Integrated Debugger

    + 13. Developer Options/Integrated Debugger
    -

    Have a look at this page for integrated debugger - documentation. +

    Many options are available for ROM developers, which are described in + different sections of this manual, as follows:

    +

      +
    • Developer key-combo shortcuts, used to change TIA state dynamically + (ie, while the emulation is still running). See Section 7 - + Keyboard Layout for more information.
      • + +
    • Commandline options influencing emulation state. See the Command + Line options under Section 5 - Starting a Game) + for more information.
      • + +
    • Viewing TIA/console information overlaid on the TIA image. This option + can be enabled from the commandline or using the Alt/ShiftCmd-l key combo, + and is extremely useful for viewing the current scanline count and associated + frames per second, bankswitch and display formats, etc. The following shows + an example of this information: +

      +

      The three lines of output describe the following: +

        +
      1. Number of scanlines in current frame, and associated framerate. Note + that the framerate shown is the internal framerate (it's + calculated from the number of scanlines).
        2. +
      2. Display format. If the characters 'AUTO =>' are present, it means + the display format was auto-detected as shown. For the given example, + the format was auto-detected as 'NTSC'.
        3. +
      3. Cartridge information. If the characters 'AUTO =>' are present, + it means the bankswitch format was auto-detected as shown. The item + in round brackets indicates ROM size. The item in square brackets + indicates the starting bank(s) used by the cart. + For the given example, the bankswitch type was auto-detected as 4K, + the file size was 4K (4096 bytes), and the start bank was 0 + (since a 4K ROM has only one bank). FIXME - image must be updated
        4. + +

      • +

    + +

    Finally, Stella contains an extensive, built-in debugger. Have a look at + this page for integrated debugger documentation.

    +