savestate and other bugfixes
[fceu.git] / Documentation / rel / 2.0.dos
1 /******************************************************************************/
2 /*  2.0) Starting FCE Ultra                                                   */
3 /******************************************************************************/
4
5         Start FCE Ultra using the following format:
6
7         fceu <arguments> romimage.nes
8
9         <arguments> can be one or more of the following:
10
11         -vmode x        Select video mode(all are 8 bpp).
12                          1 = 256x240 @ 72 hz    <Default>
13                          2 = 256x256 @ 65 hz
14                          3 = 256x256(with scanlines) @ 120 hz
15                          6 = 256x224(with scanlines) @ 120 hz
16                          8 = 256x224 @ 103 hz
17         -vsync x        Wait for the screen's vertical retrace before updating 
18                         the screen.  This *may* cause sound distortion.
19                          0 = Disabled.  <Default>
20                          1 = Enabled.
21         -cpalette x     Load a custom global palette from file x.
22                         The filename x is saved in the configuration file,
23                         not the data from the file.  Note that you should
24                         probably use an absolute("C:\nes\test.pal") filename
25                         rather than a relative("test.pal") filename.  If x is 0,
26                         the default (built in) global palette will be used.
27         -ntsccol        Emulate an NTSC's TV's colors based on user-supplied
28                         hue and tint values.
29                          0 = Disabled.
30                          1 = Enabled.
31         -sound   x      Sound.          <Default=44100>
32                          0 = Disabled.
33                          Otherwise, x = playback rate in samples per second.
34         -soundvol x     Sound volume. x is an integral percentage value.
35                         The default value is, obviously, 100.
36                         Setting it higher will increase the likelihood that
37                         sound clipping will occur.  This shouldn't be noticeable
38                         if the volume is reasonable(200% or lower; perhaps even
39                         higher for many games).
40         -f8bit x        Force 8-bit sound.  Enabling this will decrease
41                         sound quality noticeably without increasing
42                         performance noticeably.  Only use when 16-bit sound
43                         is problematic.
44                          0 = Disabled.  <Default>
45                          1 = Enabled.
46         -nothrottle x   Disables speed throttling used when sound is disabled
47                         if x is non-zero.  The default value of x is 0.
48         -joy x          Joystick mapped to virtual joystick x.
49                          0 = Disabled, reset configuration.
50         -inputx str     Select device mapped to virtual NES-style input port
51                         x(1-2).
52                         The default for both virtual input ports is "gamepad".
53                          str may be: none, gamepad, zapper, powerpada,
54                                      powerpadb, arkanoid
55         -fcexp str      Select Famicom expansion port device.  If you select
56                         a device other than "none", you should enable the
57                         "gamepad" on both NES-style virtual input ports.
58                         The default is "none".
59                          str may be: none, shadow, arkanoid, 4player, fkb
60         -nofs x         Disables Four-Score emulation if x is 1.  Default is 0.
61                         Note that Four-Score emulation will only be active
62                         if "gamepad" is mapped to one or both virtual input
63                         ports.
64         -gg             Enable Game Genie emulation.
65         -pal            Emulate a PAL NES.
66         -no8lim x       Disables the 8 sprites per scanline limitation.
67                          0 = Limitation enabled.        <Default>
68                          1 = Limitation disabled.
69         -subase x       Save extra game data files(such as battery-backed RAM)
70                         under the base directory if enabled.
71                          0 = Disabled.  <Default>
72                          1 = Enabled.
73         -snapname x     Selects what type of file name screen snapshots will
74                         have.
75                          0 = Numeric(0.png)     <Default>
76                          1 = File base and numeric(mario-0.png)
77         -clipsides x    Clip leftmost and rightmost 8 columns of pixels of
78                         video output.
79                          0 = Disabled.  <Default>
80                          1 = Enabled.
81         -slstart x      Set the first drawn emulated scanline for NTSC emulation
82                         mode.  Valid values for x are 0 through 239.
83                         The default value is 8.
84         -slend x        Set the last drawn emulated scanline for NTSC emulation
85                         mode. Valid values for x are 0 through 239.
86                         The default value is 239.
87         -slstartp x     Set the first drawn emulated scanline for PAL emulation
88                         mode.  Valid values for x are 0 through 239.  
89                         The default value is 0.
90         -slendp x       Set the last drawn emulated scanline for PAL emulation
91                         mode. Valid values for x are 0 through 239.
92                         The default value is 239.
93