diff --git a/files/{1DB6043F-35B9-4909-A413-5B6216E7F320}.htm b/files/{1DB6043F-35B9-4909-A413-5B6216E7F320}.htm index 1fcb25cd..7c7e1f70 100644 --- a/files/{1DB6043F-35B9-4909-A413-5B6216E7F320}.htm +++ b/files/{1DB6043F-35B9-4909-A413-5B6216E7F320}.htm @@ -183,7 +183,7 @@ p,ul,ol /* Paragraph Style */


Hide Menu


-

Hides the Menu commands on the FCEUX main window.  Pres ESC to unhide the menu.

+

Hides the Menu commands on the FCEUX main window.  Press ESC to unhide the menu.



Game Genie

@@ -221,7 +221,7 @@ p,ul,ol /* Paragraph Style */


Auto-savestates


-

Enables the Auto-save feature.  If enabled, FCEUX will make periodic savestates as you play (or play/record a movie).  You can right-click and select the "load last auto-save" in the context menu or press the Auto-save hotkey to back up to the last auto-save savestate.

+

Enables the Auto-save feature.  If enabled, FCEUX will make periodic savestates (once per every 256 frames) as you play or record a movie.  You can right-click and select the "load last auto-save" in the context menu or press "Load Last Auto-save" hotkey to rewind to the last auto-save savestate.



Frame Adv. - Skip Lag

@@ -236,7 +236,7 @@ p,ul,ol /* Paragraph Style */

Enabled by default.  This option allows for savestate & loadstate Undo (& redo). (see context menu)



-

Compression Savestates

+

Compress Savestates


Enabled by default.  This option compresses non movie savestates.


@@ -248,7 +248,7 @@ p,ul,ol /* Paragraph Style */


When input comes from a movie file rather than then user, it is displayed in a different color (silver)


-

The input display can also be toggled by hotkey/  The default key for toggling the Input display is the "," (comma) key.  (This can be re-mapped in the Map Hotkeys Menu).

+

The input display can also be toggled by hotkey.  The default key for toggling the Input display is the "," (comma) key.  (This can be re-mapped in the Map Hotkeys Menu).



Lag Counter

@@ -257,21 +257,34 @@ p,ul,ol /* Paragraph Style */


The lag counter value is stored in savestates.   


-

Displaying the lag counter can be done by hotkey as well.  It must be mapped to a hotkey in the Map Hokeys Menu.

-

It can be reset to 0 by mapping the reset lag counter hokey in the Map Hotkeys Menu.

+

Displaying the lag counter can also be toggled by hotkey.  The default key is the "/" (slash) key.  (This can be re-mapped in the Map Hotkeys Menu).



Frame Counter


Toggles the display of the frame counter.  The frame counter will increment once per frame.


+

The frame counter display can also be toggled by hotkey.  The default key is the "." (period) key.  (This can be re-mapped in the Map Hotkeys Menu).


-

Display BG

+


+

Rerecord Counter

+


+

Toggles the display of the number of Rerecords done when making a movie.  The Rerecord counter will increment every time you load a savestate in Recording mode.

+


+

The rerecord counter display can also be toggled by hotkey.  The default key is the "M" key.  (This can be re-mapped in the Map Hotkeys Menu).

+


+


+

Movie status icon

+


+

Toggles the display of "pause", "play" or "record" icons in the lower right corner.

+


+


+

Graphics: BG

Turning this off will turn off the backgrounds in the game.



-

Display OBJ

-

Turning this off will turn off the objects in the game.

+

Graphics: OBJ

+

Turning this off will turn off the objects (sprites) in the game.


Note: You can set the default color when the Backgrounds are turned off.  To do so, open fceux.cfg and change the value of the entry named: gNoBGFillColor


@@ -279,7 +292,7 @@ p,ul,ol /* Paragraph Style */

Save Config File


Saves current settings to fceux.cfg.  Normally settings are not saved until FCEUX is closed.

-

2008

+

2012

This help file has been generated by the freeware version of HelpNDoc

diff --git a/files/{54E785A1-1E42-4B8F-B3E2-94BAA91750B9}.htm b/files/{54E785A1-1E42-4B8F-B3E2-94BAA91750B9}.htm index 8081f6be..3966ab0d 100644 --- a/files/{54E785A1-1E42-4B8F-B3E2-94BAA91750B9}.htm +++ b/files/{54E785A1-1E42-4B8F-B3E2-94BAA91750B9}.htm @@ -156,7 +156,7 @@ p,ul,ol /* Paragraph Style */


FCEUX supports automatic IPS patching. 


-

Place the IPS file in the same directory as the file to load, and name it [filename].ips.

+

Place the IPS file in the same directory as the file to load, and name it [filename.extension].ips.


        Examples:        Boat.nes -      Boat.nes.ips

                        Boat.zip -       Boat.zip.ips

@@ -167,7 +167,7 @@ p,ul,ol /* Paragraph Style */

(Some operating systems and environments will hide file extensions. Keep this in mind if you are having trouble.)


Patching is supported for all supported formats (iNES, FDS, UNIF, and NSF), but it will probably only be useful for the iNES and FDS formats. UNIF files can't be patched well with the IPS format because they are chunk-based with no fixed offsets.

-

2008

+

2012

This help file has been generated by the freeware version of HelpNDoc

diff --git a/files/{75E1BB96-B43D-4D24-B1C3-120890F15B94}.htm b/files/{75E1BB96-B43D-4D24-B1C3-120890F15B94}.htm index a609b07e..8011d8aa 100644 --- a/files/{75E1BB96-B43D-4D24-B1C3-120890F15B94}.htm +++ b/files/{75E1BB96-B43D-4D24-B1C3-120890F15B94}.htm @@ -153,14 +153,19 @@ p,ul,ol /* Paragraph Style */


The movie option dialog has various settings related to movie making.


+

Always suggest Read-Only replay

+


+

If checked, FCEUX will automatically check "Open Read-Only" checkbox when showing "Play Movie" dialog. If unchecked, the "Open Read-Only" checkbox state will depend on current movie status.

+


+


Pause After Movie Playback


-

If checked, FCEUX will automatically pause emulation when reaching the last frame of a movie file.  If disabled, the movie will end, and emulation will continue without a movie loaded.

+

If checked, FCEUX will automatically pause emulation when reaching the last frame of a movie file.



-

Show Movie Status Icon

+

Close After Movie Playback


-

The status Icon shows the "play" "record" and "pause" icons in the lower right corner.  The Show Status Icon checkbox toggles these on/off.

+

If checked, FCEUX will close the movie after replaying its last frame. If unchecked, when reaching the last frame the movie will switch to "MOVIE_FINISHED" state, still allowing you to load its savestates.



Bind savestates to movies

@@ -183,7 +188,13 @@ p,ul,ol /* Paragraph Style */

If checked, the auto-movie backup is toggled on.  Whenever a movie is loaded then set into record mode (by loading a savestate while in read-write mode), a backup copy of the .fm2 is saved before changing the file. 


Movie backups will be created only once each time a movie is loaded into FCEUX.  Movie backups are appended with a backup number and the .bak file extension.

-

2008

+


+


+

Load full savestate-movies

+


+

If checked, FCEUX will not truncate movie immediately when you load its savestate in Recording mode (thus behaving similar to VBA-rr and Snes9x emulators). If unchecked, the movie will always shrink to the frame of the savestate you loaded.

+


+

2012

This help file has been generated by the freeware version of HelpNDoc

diff --git a/files/{A1A11C4E-B38E-471A-86EE-727D152EB764}.htm b/files/{A1A11C4E-B38E-471A-86EE-727D152EB764}.htm index 0479d2ba..e52da76b 100644 --- a/files/{A1A11C4E-B38E-471A-86EE-727D152EB764}.htm +++ b/files/{A1A11C4E-B38E-471A-86EE-727D152EB764}.htm @@ -154,14 +154,14 @@ p,ul,ol /* Paragraph Style */

-Select "Record AVI" in the File > AVI/Wav menu.

-Select a file location and the video codec you wish to use.

-Unpause the emulator.

-

-When capturing is complete, pause the emulator and select "Sop AVI" in the File Menu.

+

-When capturing is complete, pause the emulator and select "Stop AVI" in the File Menu.



Capture Audio only


To capture audio only, navigate to File > AVI/Wav > Record WAV.  Pick a filename and destination for FCEUX to begin capturing the audio to a .wav file (raw .pcm).  To stop WAV recording, select File > AVI/Wav > Stop WAV.


-

2008

+

2012

This help file has been generated by the freeware version of HelpNDoc

diff --git a/files/{C76AEBD9-1E27-4045-8A37-69E5A52D0F9A}.htm b/files/{C76AEBD9-1E27-4045-8A37-69E5A52D0F9A}.htm index f4e8b2f5..26d03bf9 100644 --- a/files/{C76AEBD9-1E27-4045-8A37-69E5A52D0F9A}.htm +++ b/files/{C76AEBD9-1E27-4045-8A37-69E5A52D0F9A}.htm @@ -184,7 +184,7 @@ p,ul,ol /* Paragraph Style */


If you load a state by accident, you can right-click and select "Undo Loadstate" to restore the emulator back to the state it was in before the loadstate.  Upon using undo loadstate, a redo loadstate will appear as an option. 


-

If you make a savestate, it will overwrite the existing savestate for that slot.  You have the option to undo this and restore the previous savestate file by right-clicking and selecting undo savestate.  Once you undo, you will have the option to redo savestate to restore the savestate that you made.  You can also map a hotkey to this function.

+

If you make a savestate, it will overwrite the existing savestate for that slot.  You have the option to undo this and restore the previous savestate file by right-clicking and selecting undo savestate.  Once you undo, you will have the option to redo savestate to restore the savestate that you made.  You can also map a hotkey to this function, by default it's mapped to Ctrl+Z.



2008

diff --git a/files/{D3F1816D-0770-4257-98D2-A21456B07D28}.htm b/files/{D3F1816D-0770-4257-98D2-A21456B07D28}.htm index 9b9dcb40..3214c893 100644 --- a/files/{D3F1816D-0770-4257-98D2-A21456B07D28}.htm +++ b/files/{D3F1816D-0770-4257-98D2-A21456B07D28}.htm @@ -243,11 +243,11 @@ p,ul,ol /* Paragraph Style */


Unpauses the emulator.


-

emu.exec_count(int count)

+

int emu.exec_count(int count)




-

emu.exec_time(int count)

+

int emu.exec_time(int count)




@@ -275,6 +275,10 @@ p,ul,ol /* Paragraph Style */


Returns true if emulation has started, or false otherwise. Certain operations such as using savestates are invalid to attempt before emulation has started. You probably won't need to use this function unless you want to make your script extra-robust to being started too early.


+

bool emu.paused()

+


+

Returns true if emulator is paused, false otherwise.

+


bool emu.readonly()

Alias: movie.readonly


@@ -428,6 +432,13 @@ p,ul,ol /* Paragraph Style */


joypad.read left in for backwards compatibility with older versions of FCEU/FCEUX.


+

table joypad.getimmediate(int player)

+

table joypad.readimmediate(int player)

+


+

Returns a table of every game button, where each entry is true if that button is held at the moment of calling the function, or false if it is not held. This function polls keyboard input immediately, allowing Lua to interact with user even when emulator is paused.

+


+

As of FCEUX 2.1.6, the function only works in Windows. In Linux this function will return nil.

+


table joypad.getdown(int player)

table joypad.readdown(int player)


@@ -728,6 +739,96 @@ p,ul,ol /* Paragraph Style */


Linux users might want to install xmessage to perform the work. Otherwise the dialog will appear on the shell and that's less noticeable.


+ +

Sound Library

+


+

table sound.get()

+


+

Returns current state of PSG channels in a big array.

+


+

table:
+{
+  rp2a03:
+  {
+    square1:
+    {
+      volume, -- 0.0-1.0
+      frequency, -- in hertz
+      midikey, -- 0-127
+      duty, -- 0:12.5% 1:25% 2:50% 3:75%
+      regs: -- raw register values
+      {
+        frequency -- raw freq register value
+      }
+    },
+    square2:
+    {
+      volume, -- 0.0-1.0
+      frequency, -- in hertz
+      midikey, -- 0-127
+      duty, -- 0:12.5% 1:25% 2:50% 3:75%
+      regs: -- raw register values
+      {
+        frequency -- raw freq register value
+      }
+    },
+    triangle:
+    {
+      volume, -- 0.0-1.0
+      frequency, -- in hertz (correct?)
+      midikey, -- 0-127 (correct?)
+      regs: -- raw register values
+      {
+        frequency -- raw freq register value
+      }
+    },
+    dpcm:
+    {
+      volume, -- 0.0-1.0
+      frequency, -- in hertz (correct?)
+      midikey, -- 0-127 (correct?)
+      dmcaddress, -- start position of the sample
+      dmcsize, -- size of the sample, in bytes
+      dmcloop, -- true:looped sample, false:oneshot
+      dmcseed, -- InitialRawDALatch
+      regs: -- raw register values
+      {
+        frequency -- raw freq register value
+      }
+    }
+  }
+}

+


+

TAS Editor Library

+


+

taseditor.registerauto(function func)

+

taseditor.registermanual(function func)

+

bool taseditor.engaged()

+

bool taseditor.markedframe(int frame)

+

int taseditor.getmarker(int frame)

+

int taseditor.setmarker(int frame)

+

taseditor.clearmarker(int frame)

+

string taseditor.getnote(int index)

+

taseditor.setnote(int index, string newtext)

+

int taseditor.getcurrentbranch()

+

string taseditor.getrecordermode()

+

int taseditor.getsuperimpose()

+

int taseditor.getlostplayback()

+

int taseditor.getplaybacktarget()

+

taseditor.setplayback(int frame)

+

taseditor.stopseeking()

+

taseditor.getselection()

+

taseditor.setselection()

+

int taseditor.getinput(int frame, int joypad)

+

taseditor.submitinputchange(int frame, int joypad, int input)

+

taseditor.submitinsertframes(int frame, int number)

+

taseditor.submitdeleteframes(int frame, int number)

+

int taseditor.applyinputchanges([string name])

+

taseditor.clearinputchanges()

+


+

For full description of these functions refer to TAS Editor Manual.

+


+


Bitwise Operations


All the following functions are left for backward compatibility, since LuaBitOp is embedded in FCEUX.

@@ -771,7 +872,7 @@ p,ul,ol /* Paragraph Style */


For transparancy use "clear".


-

2008

+

2012

This help file has been generated by the freeware version of HelpNDoc

diff --git a/files/{E3064992-D632-4845-8F38-20ED1A58E4D2}.htm b/files/{E3064992-D632-4845-8F38-20ED1A58E4D2}.htm index 7c0a6a9c..6c174bdf 100644 --- a/files/{E3064992-D632-4845-8F38-20ED1A58E4D2}.htm +++ b/files/{E3064992-D632-4845-8F38-20ED1A58E4D2}.htm @@ -203,10 +203,11 @@ p,ul,ol /* Paragraph Style */




-

Help menu created & compiled by adelikat.

+

Help menu created by adelikat.

+

Updated & recompiled by AnS.

Information collected and/or written/edited by adelikat.

Minor edits of lua-related text by Leeland Kirwan (FatRatKnight).

-

2008

+

2012

This help file has been generated by the freeware version of HelpNDoc