diff --git a/manual.lyx b/manual.lyx index abbbf9a3..4134a10d 100644 --- a/manual.lyx +++ b/manual.lyx @@ -72,7 +72,25 @@ Dependencies \end_layout \begin_layout Enumerate -gambatte +bsnes libsnes (for bsnes SNES core) +\end_layout + +\begin_deeper +\begin_layout Enumerate +v084-v087 (v084 or v085 for delayreset support) +\end_layout + +\begin_layout Enumerate +accuracy or compatiblity core with debugger enabled. +\end_layout + +\begin_layout Enumerate +Patched version (using included 7 patches) +\end_layout + +\end_deeper +\begin_layout Enumerate +gambatte (for gambatte core) \end_layout \begin_deeper @@ -81,7 +99,7 @@ SVN r320 \end_layout \begin_layout Enumerate -Patched version (using included patch) +Patched with included patches \end_layout \end_deeper @@ -132,7 +150,7 @@ Version 5.1.X or 5.2X. \end_deeper \begin_layout Enumerate -G++ 4.6 (4.7 might also work). +G++ 4.6 (bsnes doesn't seem to like 4.7, status for gambatte is unknown). \end_layout \begin_layout Section @@ -140,12 +158,22 @@ Building \end_layout \begin_layout Itemize -Copy gambatte sources to subdirectory 'gambatte'. +Copy bsnes sources (the bsnes subdirectory) to subdirectory 'bsnes' (for + bsnes core). \end_layout \begin_layout Itemize -Patch the bsnes sources with included patches (directory 'gambatte-patches/') +Copy gambatte sources to subdirectory 'gambatte' (for gambatte core). +\end_layout + +\begin_layout Itemize +Patch the bsnes sources with included patches (directory 'bsnes-patches/', bsnes core) +\end_layout + +\begin_layout Itemize +Patch the gambatte sources with included patches (directory 'gambatte-patches/', gambatte core) \end_layout \begin_layout Itemize @@ -170,15 +198,43 @@ ROM options \end_layout \begin_layout Itemize -gbrom: Game Boy ROM. +rom: Cartridge ROM (BIOS for special carts). + This is required. + (bsnes) \end_layout \begin_layout Itemize -gbcrom: Game Boy Color ROM. +bsx: BS-X (non-slotted) Game flash ROM. + (bsnes) \end_layout \begin_layout Itemize -gbcarom: Game Boy Color ROM (to be run with GBA initial register values). +bsxslotted: BS-X (slotted) Game flash ROM. + (bsnes) +\end_layout + +\begin_layout Itemize +dmg: DMG game ROM (bsnes) +\end_layout + +\begin_layout Itemize +slot-a: Sufami Turbo Slot A ROM (bsnes) +\end_layout + +\begin_layout Itemize +slot-b: Sufami Turbo Slot B ROM (bsnes) +\end_layout + +\begin_layout Itemize +gbrom: Game Boy ROM (gambatte) +\end_layout + +\begin_layout Itemize +gbcrom: Game Boy Color ROM (gambatte) +\end_layout + +\begin_layout Itemize +gbcarom: Game Boy Color ROM (Use GBA initial registers, gambatte) \end_layout \begin_layout Subsubsection @@ -186,7 +242,7 @@ gbcarom: Game Boy Color ROM (to be run with GBA initial register values). \end_layout \begin_layout Standard -Load as specified ROM (GB/GBC file format). +Load as specified ROM (SFC/BS/DMG/GB/GBC/ST file format). \end_layout \begin_layout Subsubsection @@ -194,8 +250,8 @@ Load as specified ROM (GB/GBC file format). \end_layout \begin_layout Standard -Override hardware detection for ROM, reading the values from (contains - extra gambatte flags). +Override hardware detection for ROM, reading the values from (BSNES + XML format or gambatte extra flags). \end_layout \begin_layout Subsubsection @@ -227,6 +283,34 @@ Set offset to apply to IPS patches. The offset must be 0 for BPS patches. \end_layout +\begin_layout Subsubsection +--region=pal (BSNES core only) +\end_layout + +\begin_layout Standard +Force ROM to be considered PAL-only. +\end_layout + +\begin_layout Itemize +Only works on SNES and SGB ROMs (not BS-X or Sufami Turbo). +\end_layout + +\begin_layout Itemize +Attempting to load NTSC movie file will error out. +\end_layout + +\begin_layout Subsubsection +--region=ntsc (BSNES core only) +\end_layout + +\begin_layout Standard +Force ROM to be considered NTSC-only. +\end_layout + +\begin_layout Itemize +Attempting to load PAL movie file will error out. +\end_layout + \begin_layout Subsection Session options \end_layout @@ -248,6 +332,68 @@ Load as movie or savestate file. All other session options are ignored. \end_layout +\begin_layout Subsubsection +--port1= (lsnes/SDL, bsnes core only) +\end_layout + +\begin_layout Standard +Set type of port1. + Valid values are: +\end_layout + +\begin_layout Itemize +none: No device connected +\end_layout + +\begin_layout Itemize +gamepad: One gamepad (the default) +\end_layout + +\begin_layout Itemize +multitap: Four gamepads (warning: makes most games refuse to start) +\end_layout + +\begin_layout Itemize +mouse: Mouse. +\end_layout + +\begin_layout Subsubsection +--port2= (lsnes/SDL, bsnes core only) +\end_layout + +\begin_layout Standard +Set type of port2. + Valid values are: +\end_layout + +\begin_layout Itemize +none: No device connected (the default) +\end_layout + +\begin_layout Itemize +gamepad: One gamepad +\end_layout + +\begin_layout Itemize +multitap: Four gamepads. +\end_layout + +\begin_layout Itemize +mouse: Mouse +\end_layout + +\begin_layout Itemize +superscope: Super Scope +\end_layout + +\begin_layout Itemize +justifier: One justifier +\end_layout + +\begin_layout Itemize +justifiers: Two justifiers +\end_layout + \begin_layout Subsubsection --gamename= (lsnes/SDL) \end_layout @@ -743,6 +889,22 @@ Video framerate is usually 322445/6448 fps for PAL and 10738636/178683 fps for NTSC. \end_layout +\end_deeper +\begin_layout Itemize +INTERNAL-SDMP: Internal SDMP dumper. +\end_layout + +\begin_deeper +\begin_layout Itemize +Mode 'ms': Multi-segment. + Takes prefix. +\end_layout + +\begin_layout Itemize +Mode 'ss': Single-segment. + Takes filename. +\end_layout + \end_deeper \begin_layout Subsubsection end-dump diff --git a/manual.txt b/manual.txt index 2823be3c..1a303ff2 100644 --- a/manual.txt +++ b/manual.txt @@ -4,42 +4,58 @@ lsnes is SNES rerecording emulator based on bsnes core. 2 Dependencies -1. gambatte +1. bsnes libsnes (for bsnes SNES core) + + (a) v084-v087 (v084 or v085 for delayreset support) + + (b) accuracy or compatiblity core with debugger enabled. + + (c) Patched version (using included 7 patches) + +2. gambatte (for gambatte core) (a) SVN r320 - (b) Patched version (using included patch) + (b) Patched with included patches -2. Zlib +3. Zlib -3. boost_iostreams +4. boost_iostreams -4. boost_filesystem +5. boost_filesystem -5. boost_thread (if native std::thread is not available) +6. boost_thread (if native std::thread is not available) -6. libsdl (SDL only) +7. libsdl (SDL only) -7. sdlmain (SDL only, part of SDL) +8. sdlmain (SDL only, part of SDL) -8. boost_conversion (this is header-only library) +9. boost_conversion (this is header-only library) -9. libswscale (wxwidgets graphics only) +10. libswscale (wxwidgets graphics only) -10. Portaudio (portaudio sound only) +11. Portaudio (portaudio sound only) -11. Lua (if Lua support is needed). +12. Lua (if Lua support is needed). • Version 5.1.X or 5.2X. -12. G++ 4.6 (4.7 might also work). +13. G++ 4.6 (bsnes doesn't seem to like 4.7, status for gambatte + is unknown). 3 Building -• Copy gambatte sources to subdirectory 'gambatte'. +• Copy bsnes sources (the bsnes subdirectory) to subdirectory + 'bsnes' (for bsnes core). + +• Copy gambatte sources to subdirectory 'gambatte' (for gambatte + core). • Patch the bsnes sources with included patches (directory - 'gambatte-patches/') + 'bsnes-patches/', bsnes core) + +• Patch the gambatte sources with included patches (directory + 'gambatte-patches/', gambatte core) • Edit options.build (or copy of that file) @@ -52,21 +68,34 @@ lsnes is SNES rerecording emulator based on bsnes core. in the following can be one of: -• gbrom: Game Boy ROM. +• rom: Cartridge ROM (BIOS for special carts). This is required. + (bsnes) -• gbcrom: Game Boy Color ROM. +• bsx: BS-X (non-slotted) Game flash ROM. (bsnes) -• gbcarom: Game Boy Color ROM (to be run with GBA initial - register values). +• bsxslotted: BS-X (slotted) Game flash ROM. (bsnes) + +• dmg: DMG game ROM (bsnes) + +• slot-a: Sufami Turbo Slot A ROM (bsnes) + +• slot-b: Sufami Turbo Slot B ROM (bsnes) + +• gbrom: Game Boy ROM (gambatte) + +• gbcrom: Game Boy Color ROM (gambatte) + +• gbcarom: Game Boy Color ROM (Use GBA initial registers, + gambatte) 4.1.1 --= (lsnes/SDL, lsnes-avidump) -Load as specified ROM (GB/GBC file format). +Load as specified ROM (SFC/BS/DMG/GB/GBC/ST file format). 4.1.2 ---xml= (lsnes/SDL, lsnes-avidump) Override hardware detection for ROM, reading the values from - (contains extra gambatte flags). + (BSNES XML format or gambatte extra flags). 4.1.3 --ips-= (lsnes/SDL, lsnes-avidump) @@ -84,6 +113,20 @@ Set offset to apply to IPS patches. May be negative. Handy for applying headered IPS patches (use offset of -512 for this). The offset must be 0 for BPS patches. +4.1.6 --region=pal (BSNES core only) + +Force ROM to be considered PAL-only. + +• Only works on SNES and SGB ROMs (not BS-X or Sufami Turbo). + +• Attempting to load NTSC movie file will error out. + +4.1.7 --region=ntsc (BSNES core only) + +Force ROM to be considered NTSC-only. + +• Attempting to load PAL movie file will error out. + 4.2 Session options 4.2.1 --pause @@ -95,29 +138,60 @@ Start paused Load as movie or savestate file. All other session options are ignored. -4.2.3 --gamename= (lsnes/SDL) +4.2.3 --port1= (lsnes/SDL, bsnes core only) + +Set type of port1. Valid values are: + +• none: No device connected + +• gamepad: One gamepad (the default) + +• multitap: Four gamepads (warning: makes most games refuse to + start) + +• mouse: Mouse. + +4.2.4 --port2= (lsnes/SDL, bsnes core only) + +Set type of port2. Valid values are: + +• none: No device connected (the default) + +• gamepad: One gamepad + +• multitap: Four gamepads. + +• mouse: Mouse + +• superscope: Super Scope + +• justifier: One justifier + +• justifiers: Two justifiers + +4.2.5 --gamename= (lsnes/SDL) Set the name of game to . Default is blank. -4.2.4 --author= (lsnes/SDL) +4.2.6 --author= (lsnes/SDL) Add author with full name of (no nickname). -4.2.5 --author=| (lsnes/SDL) +4.2.7 --author=| (lsnes/SDL) Add author with nickname of (no full name). -4.2.6 --author=| (lsnes/SDL) +4.2.8 --author=| (lsnes/SDL) Add author with full name of and nickname of . -4.2.7 --rtc-second= (lsnes/SDL) +4.2.9 --rtc-second= (lsnes/SDL) Set RTC second (0 is 1st January 1970 00:00:00Z). Default is 1,000,000,000. -4.2.8 --rtc-subsecond= (lsnes/SDL) +4.2.10 --rtc-subsecond= (lsnes/SDL) Set RTC subsecond. Range is 0-. Unit is CPU cycle. Default is 0. @@ -345,6 +419,12 @@ The following dumpers are available: – Video framerate is usually 322445/6448 fps for PAL and 10738636/178683 fps for NTSC. +• INTERNAL-SDMP: Internal SDMP dumper. + + – Mode 'ms': Multi-segment. Takes prefix. + + – Mode 'ss': Single-segment. Takes filename. + 6.5.2 end-dump End dumping using