All addresses listed in the cheat search windows are in unsigned 16-bit hexadecimal format and all values in these windows are in an unsigned 8-bit decimal format(the range for values is 0 through 255).
-
Active Cheats
+
Active Cheats
The Active cheats window on the left contains the list of cheats for the currently loaded game. Existing cheats can be selected, edited, and updated using the "Update" button.
@@ -91,7 +101,7 @@
Poke Cheat Value is like turning the cheat on, but in this case there's no off switch. If the code is on when you use this, then when the code is turned off, it will revert to the value last used. Good for one time life refills, if you want that sort of thing.
Goto in Hex Editor opens the Hex Editor window, and puts the cursor on the address shown. It's somewhat similar to how Bookmarks work in the Hex Editor.
-
Cheat Search
+
Cheat Search
The cheat search is used to find a specific value in the games RAM by process of elimination.
@@ -120,22 +130,22 @@
Any value in the possibilities list can be sent to memory watch by double clicking it.
Highlighting it and hitting the "Add" button under the Active cheats window will automatically activate it as a cheat with the value set to its current value.
-
Example
+
Example
Here is an example of cheat search in action.
Let's say I am playing Mega man 3 and I want to find Mega man's energy level in the game's ram. I will start by opening the ROM and selecting a level. At this point, I know Mega man's energy address is active. So I will pause the game and open the cheat search and hit the reset button. The game uses SRAM so the possibilities window will say 10240 "possibilities".
Next I will frame advance (or briefly unpause) the game. At this point I know Mega man's energy level is still the same as it was. So I click the "equal" button. Next I want to take damage. I know for sure now that the energy level has decreased so after the "ouch" animation, I click the "Less than button". This will cut the possibilities down significantly. Next I will advance some more and click the "Equal" button since I know the value is still the previous value. I will repeat this cycle until I am down to 1 or just a few values. From there I can double click the values to send them to memory watch to monitor them more closely to weed them out. (Note: Mega man's energy is located in $00A2).
-
Context Menu
+
Context Menu
Right-clicking in the active cheats list brings up the context menu.
-
Toggle Cheat - does the same thing as double clicking
+
Toggle Cheat - does the same thing as double clicking
-
Poke cheat value - has a different affect that normal freezing, this makes a one time write of that value as opposed to freezing it temporarily to that value and having it restored later. It has the same affect as typing in values in the Hex Editor.
+
Poke cheat value - has a different affect that normal freezing, this makes a one time write of that value as opposed to freezing it temporarily to that value and having it restored later. It has the same affect as typing in values in the Hex Editor.
-
Goto In Hex Editor - Opens the Hex editor dialog to the position of the selected RAM value.
+
Goto In Hex Editor - Opens the Hex editor dialog to the position of the selected RAM value.
Plays specified ROM (ROM name must always be put last in command line arguments)
-
fceux path\rom.nes (or rom.zip)
+
fceux path\rom.nes (or rom.zip)
-
fceux smb.nes
-
fceux c:\fceux\roms\smb.zip
+
fceux smb.nes
+
fceux c:\fceux\roms\smb.zip
Play Movie File
Plays a specified movie (.fm2) file. A valid ROM must be specified or movie will not be played.
-
fcuex -playmovie path\movie.fm2 romname
+
fcuex -playmovie path\movie.fm2 romname
-
fceux -playmovie smb.fm2 smb.nes
+
fceux -playmovie smb.fm2 smb.nes
Read-only Status
Specifies whether a movie will be in "read-only" or "read & write" mode. (Note: a specified movie is not required to be used in conjunction with this command). 1 specifies read only status, 0 specifies read & write.
Lua is a scripting language. It is used in games like Farcry and World of Warcraft (and many other games and applications!). Even though you can find all kinds of tutorials online, let me help you with the basics.
@@ -60,7 +70,7 @@
When you load the script, the emulator will sort of go into pause mode and hand controls over to Lua (you!). Hence you are responsible for frameadvancing the emulator.
IF YOU DO NOT CALL emu.frameadvance AT THE CYCLE OF THE MAIN LOOP YOU WILL FREEZE THE EMULATOR! There. You have been warned. Don't worry though, you'll make this mistake at least once. Just force-quit the application and try again :)
-
Syntax
+
Syntax
Now then. Just like any other language, Lua has a few quirks you should be aware of.
@@ -163,7 +173,7 @@
For easy reference to the standard libraries look on the bottom half of this page: http://www.lua.org/manual/5.1/
Emulator background Color when Graphics Background is disabled
-
gNoBGFillColor
+
gNoBGFillColor
When you disable the backgrounds (Config > Display > Graphics: GB), the default color is black. You can change that color by modifying this value. By default it is 255 (black).
This allows you to directly edit all of the NES address space ($0000-$FFFF). While you can easily modify RAM, or write directly to registers by typing in data, you cannot modify ROM data ($8000-$FFFF) itself. This is because most mappers have registers which are located in this space; so writing there can trigger mapper operations that may cause the game to crash or glitch if you don't know what you're doing. If you want to edit the ROM itself, right-click on the offset and select "Go here in ROM file"; that will take you directly to where you need to be so you can start editing. You can also freeze RAM by clicking on it with the middle mouse button, or by using the right-click menu. This works by adding it directly to the Cheat List, which you can see from the Cheat Console. Finally, the right-click menu can be used to quickly add a read or write breakpoint to the debugger.
-
2. PPU MEMORY
+
2. PPU MEMORY
This allows you to directly view and write to PPU memory (VRAM).
-
3. THE ROM FILE
+
3. THE ROM FILE
This is possibly the coolest part of FCEUXD: It allows you to edit the ROM file in real-time, i.e. while the game is running. If you make a mistake, press Ctrl+Z or Edit->Undo to undo your change (then load a save-state if the game crashed). If you have the Code/Data Logger running, then bytes that were logged as code will be colored yellow, while bytes logged as data will be colored blue. Bytes that have been logged as code *and* data will be colored green.
The Hex Editor also has support for table files (*.tbl) to map bytes to text. Each line consists of four characters of the form "xx=y", where "xx" is the hex value, and "y" is the character that that value represents. I have also added an extension to represent the Return key: xx=ret whereby pressing the Return key will enter that value into the ROM. You can copy/paste data or text by selecting it and using Ctrl+Z (to copy) and Ctrl+V (to paste). Plus, there is an Edit->Find feature that you can use to search for data. This feature should be fairly intuitive, so I won't bother to explain it.
On the pull down menus, you can select the device you want to be emulated on input ports 1 and 2 (game pad, zapper, pad, paddle). If you check the box labeled "Attach four-score(implies four gamepads)", you won't be able to select any of these options, because the four-score allowed someone to use 2 extra controllers.
The device currently being emulated on each port is listed above the drop down list; loading certain games will override your settings, but only temporarily.
@@ -74,17 +84,17 @@
Checking this box will replace the Start button used by controller 2 with the microphone option found on the famicom. Pressing the Microphone button is like blowing or yelling into it on the console equipment. The Port 2 controller used for the Famicom included a microphone and a volume control in place of the Start and Select buttons. This option isn't automatically detected, so it has to be manually enabled by the user. Movie files may also enable and use this feature. Both Famicom Cartridges and Famicom Disks have made use of this feature, such as both the cartridge and disk version of Zelda 1, Hikari Shinwa, and Takeshi no Chosenjo. Games other than those listed here use this feature.
-
Input Presets
-
+
Input Presets
+
This feature allow you to set the current input configuration to one of three presets. This gives you the option to quickly change from one input configuration to another (such as toggling between 1 or 2 controllers and/or toggling from controller 2 being bound to controller 1 or having its own controls).
To assign the current input configuration to a preset press the down arrow next to one of the presets. To assign the preset as the current input configuration press the up arrow or use the hotkey assigned to that specific preset. Preset hotkeys can be assigned in the Map Hotkeys menu.
-
Disable left+right/up+down
+
Disable left+right/up+down
By default FCEUX allows you to press both the left and right controls at the same time (or up and down). To disable this feature uncheck the checkbox on the left.
-
Auto-Hold
+
Auto-Hold
Clicking the auto hold button will allow you to assign a hotkey to the auto-hold feature.
Clicking the clear button will allow you to assign a hotkey to the clear auto-holds feature.
The following functions are available in FCEUX, in addition to standard LUA capabilities:
-
Emu library
+
Emu library
-
emu.poweron()
-
-
Executes a power cycle.
-
-
emu.softreset()
-
-
Executes a (soft) reset.
+
emu.poweron()
+
+
Executes a power cycle.
+
+
emu.softreset()
+
+
Executes a (soft) reset.
-
emu.speedmode(string mode)
-
-
Set the emulator to given speed. The mode argument can be one of these:
-
- "normal"
-
- "nothrottle" (same as turbo on fceux)
-
- "turbo"
-
- "maximum"
-
-
emu.frameadvance()
-
-
Advance the emulator by one frame. It's like pressing the frame advance button once.
-
-
Most scripts use this function in their main game loop to advance frames. Note that you can also register functions by various methods that run "dead", returning control to the emulator and letting the emulator advance the frame. For most people, using frame advance in an endless while loop is easier to comprehend so I suggest starting with that. This makes more sense when creating bots. Once you move to creating auxillary libraries, try the register() methods.
-
-
emu.pause()
-
-
Pauses the emulator.
-
-
emu.unpause()
-
-
Unpauses the emulator.
-
-
emu.exec_count(int count, function func)
-
-
Calls given function, restricting its working time to given number of lua cycles. Using this method you can ensure that some heavy operation (like Lua bot) won't freeze FCEUX.
-
-
emu.exec_time(int time, function func)
-
-
Windows-only. Calls given function, restricting its working time to given number of milliseconds (approximate). Using this method you can ensure that some heavy operation (like Lua bot) won't freeze FCEUX.
Toggles the drawing of the sprites and background planes. Set to false or nil to disable a pane, anything else will draw them.
-
-
emu.message(string message)
-
-
Displays given message on screen in the standard messages position. Use gui.text() when you need to position text.
-
-
int emu.framecount()
-
-
Returns the framecount value. The frame counter runs without a movie running so this always returns a value.
-
-
int emu.lagcount()
-
-
Returns the number of lag frames encountered. Lag frames are frames where the game did not poll for input because it missed the vblank. This happens when it has to compute too much within the frame boundary. This returns the number indicated on the lag counter.
-
-
bool emu.lagged()
-
-
Returns true if currently in a lagframe, false otherwise.
-
-
bool emu.emulating()
-
-
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
-
-
Returns whether the emulator is in read-only state.
-
-
While this variable only applies to movies, it is stored as a global variable and can be modified even without a movie loaded. Hence, it is in the emu library rather than the movie library.
-
-
emu.setreadonly(bool state)
-
Alias: movie.setreadonly
-
-
Sets the read-only status to read-only if argument is true and read+write if false.
-
Note: This might result in an error if the medium of the movie file is not writeable (such as in an archive file).
-
-
While this variable only applies to movies, it is stored as a global variable and can be modified even without a movie loaded. Hence, it is in the emu library rather than the movie library.
-
-
emu.registerbefore(function func)
-
-
Registers a callback function to run immediately before each frame gets emulated. This runs after the next frame's input is known but before it's used, so this is your only chance to set the next frame's input using the next frame's would-be input. For example, if you want to make a script that filters or modifies ongoing user input, such as making the game think "left" is pressed whenever you press "right", you can do it easily with this.
-
-
Note that this is not quite the same as code that's placed before a call to emu.frameadvance. This callback runs a little later than that. Also, you cannot safely assume that this will only be called once per frame. Depending on the emulator's options, every frame may be simulated multiple times and your callback will be called once per simulation. If for some reason you need to use this callback to keep track of a stateful linear progression of things across frames then you may need to key your calculations to the results of emu.framecount.
-
-
Like other callback-registering functions provided by FCEUX, there is only one registered callback at a time per registering function per script. If you register two callbacks, the second one will replace the first, and the call to emu.registerbefore will return the old callback. You may register nil instead of a function to clear a previously-registered callback. If a script returns while it still has registered callbacks, FCEUX will keep it alive to call those callbacks when appropriate, until either the script is stopped by the user or all of the callbacks are de-registered.
-
-
emu.registerafter(function func)
-
-
Registers a callback function to run immediately after each frame gets emulated. It runs at a similar time as (and slightly before) gui.register callbacks, except unlike with gui.register it doesn't also get called again whenever the screen gets redrawn. Similar caveats as those mentioned in emu.registerbefore apply.
-
-
emu.registerexit(function func)
-
-
Registers a callback function that runs when the script stops. Whether the script stops on its own or the user tells it to stop, or even if the script crashes or the user tries to close the emulator, FCEUX will try to run whatever Lua code you put in here first. So if you want to make sure some code runs that cleans up some external resources or saves your progress to a file or just says some last words, you could put it here. (Of course, a forceful termination of the application or a crash from inside the registered exit function will still prevent the code from running.)
-
-
Suppose you write a script that registers an exit function and then enters an infinite loop. If the user clicks "Stop" your script will be forcefully stopped, but then it will start running its exit function. If your exit function enters an infinite loop too, then the user will have to click "Stop" a second time to really stop your script. That would be annoying. So try to avoid doing too much inside the exit function.
-
-
Note that restarting a script counts as stopping it and then starting it again, so doing so (either by clicking "Restart" or by editing the script while it is running) will trigger the callback. Note also that returning from a script generally does NOT count as stopping (because your script is still running or waiting to run its callback functions and thus does not stop... see here for more information), even if the exit callback is the only one you have registered.
-
-
bool emu.addgamegenie(string str)
-
-
Adds a Game Genie code to the Cheats menu. Returns false and an error message if the code can't be decoded. Returns false if the code couldn't be added. Returns true if the code already existed, or if it was added.
-
-
Usage: emu.addgamegenie("NUTANT")
-
-
Note that the Cheats Dialog Box won't show the code unless you close and reopen it.
-
-
bool emu.delgamegenie(string str)
-
-
Removes a Game Genie code from the Cheats menu. Returns false and an error message if the code can't be decoded. Returns false if the code couldn't be deleted. Returns true if the code didn't exist, or if it was deleted.
-
-
Usage: emu.delgamegenie("NUTANT")
-
-
Note that the Cheats Dialog Box won't show the code unless you close and reopen it.
-
-
emu.print(string str)
-
-
Puts a message into the Output Console area of the Lua Script control window. Useful for displaying usage instructions to the user when a script gets run.
-
-
emu.getscreenpixel(int x, int y, bool getemuscreen)
-
-
Returns the separate RGB components of the given screen pixel, and the palette. Can be 0-255 by 0-239, but NTSC only displays 0-255 x 8-231 of it. If getemuscreen is false, this gets background colors from either the screen pixel or the LUA pixels set, but LUA data may not match the information used to put the data to the screen. If getemuscreen is true, this gets background colors from anything behind an LUA screen element.
-
-
Usage is local r,g,b,palette = emu.getscreenpixel(5, 5, false) to retrieve the current red/green/blue colors and palette value of the pixel at 5x5.
-
-
Palette value can be 0-63, or 254 if there was an error.
-
-
You can avoid getting LUA data by putting the data into a function, and feeding the function name to emu.registerbefore.
-
-
FCEU library
-
-
The FCEU library is the same as the emu library. It is left in for backwards compatibility. However, the emu library is preferred.
-
-
ROM Library
-
-
rom.readbyte(int address)
-
rom.readbyteunsigned(int address)
-
-
Get an unsigned byte from the actual ROM file at the given address.
-
-
This includes the header! It's the same as opening the file in a hex-editor.
-
-
rom.readbytesigned(int address)
-
-
Get a signed byte from the actual ROM file at the given address. Returns a byte that is signed.
-
-
This includes the header! It's the same as opening the file in a hex-editor.
-
-
Memory Library
-
-
memory.readbyte(int address)
-
memory.readbyteunsigned(int address)
-
-
Get an unsigned byte from the RAM at the given address. Returns a byte regardless of emulator. The byte will always be positive.
-
-
memory.readbyterange(int address, int length)
-
-
Get a length bytes starting at the given address and return it as a string. Convert to table to access the individual bytes.
-
-
memory.readbytesigned(int address)
-
-
Get a signed byte from the RAM at the given address. Returns a byte regardless of emulator. The most significant bit will serve as the sign.
-
-
memory.writebyte(int address, int value)
-
-
Write the value to the RAM at the given address. The value is modded with 256 before writing (so writing 257 will actually write 1). Negative values allowed.
-
-
int memory.getregister(cpuregistername)
-
-
Returns the current value of the given hardware register.
-
For example, memory.getregister("pc") will return the main CPU's current Program Counter.
-
-
Valid registers are: "a", "x", "y", "s", "p", and "pc".
-
-
memory.setregister(string cpuregistername, int value)
-
-
Sets the current value of the given hardware register.
-
For example, memory.setregister("pc",0x200) will change the main CPU's current Program Counter to 0x200.
-
-
Valid registers are: "a", "x", "y", "s", "p", and "pc".
-
-
You had better know exactly what you're doing or you're probably just going to crash the game if you try to use this function. That applies to the other memory.write functions as well, but to a lesser extent.
-
-
memory.register(int address, [int size,] function func)
-
memory.registerwrite(int address, [int size,] function func)
-
-
Registers a function to be called immediately whenever the given memory address range is written to.
-
-
size is the number of bytes to "watch". For example, if size is 100 and address is 0x0200, then you will register the function across all 100 bytes from 0x0200 to 0x0263. A write to any of those bytes will trigger the function. Having callbacks on a large range of memory addresses can be expensive, so try to use the smallest range that's necessary for whatever it is you're trying to do. If you don't specify any size then it defaults to 1.
-
-
The callback function will receive two arguments, (address, size) indicating what write operation triggered the callback. If you don't care about that extra information then you can ignore it and define your callback function to not take any arguments. The value that was written is NOT passed into the callback function, but you can easily use any of the memory.read functions to retrieve it.
-
-
You may use a memory.write function from inside the callback to change the value that just got written. However, keep in mind that doing so will trigger your callback again, so you must have a "base case" such as checking to make sure that the value is not already what you want it to be before writing it. Another, more drastic option is to de-register the current callback before performing the write.
-
-
If func is nil that means to de-register any memory write callbacks that the current script has already registered on the given range of bytes.
-
-
memory.registerexec(int address, [int size,] function func)
-
memory.registerrun(int address, [int size,] function func)
-
memory.registerexecute(int address, [int size,] function func)
-
-
Registers a function to be called immediately whenever the emulated system runs code located in the given memory address range.
-
-
Besides that, most of the information about memory.register applies to this function as well.
-
-
Joypad Library
-
-
table joypad.get(int player)
-
table joypad.read(int player)
-
-
Returns a table of every game button, where each entry is true if that button is currently held (as of the last time the emulation checked), or false if it is not held. This takes keyboard inputs, not Lua. The table keys look like this (case sensitive):
-
-
up, down, left, right, A, B, start, select
-
-
Where a Lua truthvalue true means that the button is set, false means the button is unset. Note that only "false" and "nil" are considered a false value by Lua. Anything else is true, even the number 0.
-
-
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)
-
-
Returns a table of only the game buttons that are currently held. Each entry is true if that button is currently held (as of the last time the emulation checked), or nil if it is not held.
-
-
table joypad.getup(int player)
-
table joypad.readup(int player)
-
-
Returns a table of only the game buttons that are not currently held. Each entry is nil if that button is currently held (as of the last time the emulation checked), or false if it is not held.
-
-
joypad.set(int player, table input)
-
joypad.write(int player, table input)
-
-
Set the inputs for the given player. Table keys look like this (case sensitive):
-
-
up, down, left, right, A, B, start, select
-
-
There are 4 possible values: true, false, nil, and "invert".
-
true - Forces the button on
-
false - Forces the button off
-
nil - User's button press goes through unchanged
-
"invert"- Reverses the user's button press
-
-
Any string works in place of "invert". It is suggested as a convention to use "invert" for readability, but strings like "inv", "Weird switchy mechanism", "", or "true or false" works as well as "invert".
-
-
nil and "invert" exists so the script can control individual buttons of the controller without entirely blocking the user from having any control. Perhaps there is a process which can be automated by the script, like an optimal firing pattern, but the user still needs some manual control, such as moving the character around.
-
-
joypad.write left in for backwards compatibility with older versions of FCEU/FCEUX.
-
-
-
Zapper Library
-
-
table zapper.read()
-
-
Returns the zapper data
-
When no movie is loaded this input is the same as the internal mouse input (which is used to generate zapper input, as well as the arkanoid paddle).
-
-
When a movie is playing, it returns the zapper data in the movie code.
-
-
The return table consists of 3 values: x, y, and fire. x and y are the x,y coordinates of the zapper target in terms of pixels. fire represents the zapper firing. 0 = not firing, 1 = firing
-
-
-
Note: The zapper is always controller 2 on the NES so there is no player argument to this function.
-
-
-
Input Library
-
-
table input.get()
-
table input.read()
-
-
Reads input from keyboard and mouse. Returns pressed keys and the position of mouse in pixels on game screen. The function returns a table with at least two properties; table.xmouse and table.ymouse. Additionally any of these keys will be set to true if they were held at the time of executing this function:
Requests input from the user using a multiple-option message box. See gui.popup for complete usage and returns.
-
-
Savestate Library
-
-
object savestate.object(int slot = nil)
-
-
Create a new savestate object. Optionally you can save the current state to one of the predefined slots(1-10) using the range 1-9 for slots 1-9, and 10 for 0, QWERTY style. Using no number will create an "anonymous" savestate.
-
Note that this does not actually save the current state! You need to create this value and pass it on to the load and save functions in order to save it.
-
-
Anonymous savestates are temporary, memory only states. You can make them persistent by calling memory.persistent(state). Persistent anonymous states are deleted from disk once the script exits.
-
-
object savestate.create(int slot = nil)
-
-
savestate.create is identical to savestate.object, except for the numbering for predefined slots(1-10, 1 refers to slot 0, 2-10 refer to 1-9). It's being left in for compatibility with older scripts, and potentially for platforms with different internal predefined slot numbering.
-
-
savestate.save(object savestate)
-
-
Save the current state object to the given savestate. The argument is the result of savestate.create(). You can load this state back up by calling savestate.load(savestate) on the same object.
-
-
savestate.load(object savestate)
-
-
Load the the given state. The argument is the result of savestate.create() and has been passed to savestate.save() at least once.
-
-
If this savestate is not persistent and not one of the predefined states, the state will be deleted after loading.
-
-
savestate.persist(object savestate)
-
-
Set the given savestate to be persistent. It will not be deleted when you load this state but at the exit of this script instead, unless it's one of the predefined states. If it is one of the predefined savestates it will be saved as a file on disk.
-
-
savestate.registersave(function func)
-
-
Registers a callback function that runs whenever the user saves a state. This won't actually be called when the script itself makes a savestate, so none of those endless loops due to a misplaced savestate.save.
-
-
As with other callback-registering functions provided by FCEUX, there is only one registered callback at a time per registering function per script. Upon registering a second callback, the first is kicked out to make room for the second. In this case, it will return the first function instead of nil, letting you know what was kicked out. Registering nil will clear the previously-registered callback.
-
-
savestate.registerload(function func)
-
-
Registers a callback function that runs whenever the user loads a previously saved state. It's not called when the script itself loads a previous state, so don't worry about your script interrupting itself just because it's loading something.
-
-
The state's data is loaded before this function runs, so you can read the RAM immediately after the user loads a state, or check the new framecount. Particularly useful if you want to update lua's display right away instead of showing junk from before the loadstate.
-
-
savestate.loadscriptdata(int location)
-
-
Accuracy not yet confirmed.
-
-
Intended Function, according to snes9x LUA documentation:
-
Returns the data associated with the given savestate (data that was earlier returned by a registered save callback) without actually loading the rest of that savestate or calling any callbacks. location should be a save slot number.
-
-
-
Movie Library
-
-
bool movie.active()
-
-
Returns true if a movie is currently loaded and false otherwise. (This should be used to guard against Lua errors when attempting to retrieve movie information).
-
-
int movie.framecount()
-
-
Returns the current frame count. (Has the same affect as emu.framecount)
-
-
string movie.mode()
-
-
Returns the current state of movie playback. Returns one of the following:
-
-
- "record"
-
- "playback"
-
- "finished"
-
- "taseditor"
-
- nil
-
-
movie.rerecordcounting(bool counting)
-
-
Turn the rerecord counter on or off. Allows you to do some brute forcing without inflating the rerecord count.
-
-
movie.stop()
-
movie.close()
-
-
Stops movie playback. If no movie is loaded, it throws a Lua error.
-
-
int movie.length()
-
-
Returns the total number of frames of the current movie. Throws a Lua error if no movie is loaded.
-
-
string movie.name()
-
string movie.getname()
-
-
Returns the filename of the current movie with path. Throws a Lua error if no movie is loaded.
-
-
movie.getfilename()
-
-
Returns the filename of the current movie with no path. Throws a Lua error if no movie is loaded.
-
-
movie.rerecordcount()
-
-
Returns the rerecord count of the current movie. Throws a Lua error if no movie is loaded.
-
-
movie.replay()
-
movie.playbeginning()
-
-
Performs the Play from Beginning function. Movie mode is switched to read-only and the movie loaded will begin playback from frame 1.
-
-
If no movie is loaded, no error is thrown and no message appears on screen.
-
-
bool movie.readonly()
-
bool movie.getreadonly()
-
Alias: emu.getreadonly
-
-
FCEUX keeps the read-only status even without a movie loaded.
-
-
Returns whether the emulator is in read-only state.
-
-
While this variable only applies to movies, it is stored as a global variable and can be modified even without a movie loaded. Hence, it is in the emu library rather than the movie library.
-
-
movie.setreadonly(bool state)
-
Alias: emu.setreadonly
-
-
FCEUX keeps the read-only status even without a movie loaded.
-
-
Sets the read-only status to read-only if argument is true and read+write if false.
-
Note: This might result in an error if the medium of the movie file is not writeable (such as in an archive file).
-
-
While this variable only applies to movies, it is stored as a global variable and can be modified even without a movie loaded. Hence, it is in the emu library rather than the movie library.
-
-
bool movie.recording()
-
-
Returns true if there is a movie loaded and in record mode.
-
-
bool movie.playing()
-
-
Returns true if there is a movie loaded and in play mode.
-
-
bool movie.ispoweron()
-
-
Returns true if the movie recording or loaded started from 'Start'.
-
Returns false if the movie uses a save state.
-
Opposite of movie.isfromsavestate()
-
-
bool movie.isfromsavestate()
-
-
Returns true if the movie recording or loaded started from 'Now'.
-
Returns false if the movie was recorded from a reset.
-
Opposite of movie.ispoweron()
-
-
string movie.name()
-
-
If a movie is loaded it returns the name of the movie, else it throws an error.
-
-
bool movie.readonly()
-
-
Returns the state of read-only. True if in playback mode, false if in record mode.
-
-
GUI Library
-
-
gui.pixel(int x, int y, type color)
-
gui.drawpixel(int x, int y, type color)
-
gui.setpixel(int x, int y, type color)
-
gui.writepixel(int x, int y, type color)
-
-
Draw one pixel of a given color at the given position on the screen. See drawing notes and color notes at the bottom of the page.
-
-
gui.getpixel(int x, int y)
-
-
Returns the separate RGBA components of the given pixel set by gui.pixel. This only gets LUA pixels set, not background colors.
-
-
Usage is local r,g,b,a = gui.getpixel(5, 5) to retrieve the current red/green/blue/alpha values of the LUA pixel at 5x5.
-
-
See emu.getscreenpixel() for an emulator screen variant.
-
-
gui.line(int x1, int y1, int x2, int y2 [, color [, skipfirst]])
-
gui.drawline(int x1, int y1, int x2, int y2 [, color [, skipfirst]])
-
-
Draws a line between the two points. The x1,y1 coordinate specifies one end of the line segment, and the x2,y2 coordinate specifies the other end. If skipfirst is true then this function will not draw anything at the pixel x1,y1, otherwise it will. skipfirst is optional and defaults to false. The default color for the line is solid white, but you may optionally override that using a color of your choice. See also drawing notes and color notes at the bottom of the page.
-
-
gui.box(int x1, int y1, int x2, int y2 [, fillcolor [, outlinecolor]]))
-
gui.drawbox(int x1, int y1, int x2, int y2 [, fillcolor [, outlinecolor]]))
-
gui.rect(int x1, int y1, int x2, int y2 [, fillcolor [, outlinecolor]]))
-
gui.drawrect(int x1, int y1, int x2, int y2 [, fillcolor [, outlinecolor]]))
-
-
Draws a rectangle between the given coordinates of the emulator screen for one frame. The x1,y1 coordinate specifies any corner of the rectangle (preferably the top-left corner), and the x2,y2 coordinate specifies the opposite corner.
-
-
The default color for the box is transparent white with a solid white outline, but you may optionally override those using colors of your choice. Also see drawing notes and color notes.
-
-
gui.text(int x, int y, string str [, textcolor [, backcolor]])
-
gui.drawtext(int x, int y, string str [, textcolor [, backcolor]])
-
-
Draws a given string at the given position. textcolor and backcolor are optional. See 'on colors' at the end of this page for information. Using nil as the input or not including an optional field will make it use the default.
-
-
gui.parsecolor(color)
-
-
Returns the separate RGBA components of the given color.
-
For example, you can say local r,g,b,a = gui.parsecolor('orange') to retrieve the red/green/blue values of the preset color orange. (You could also omit the a in cases like this.) This uses the same conversion method that FCEUX uses internally to support the different representations of colors that the GUI library uses. Overriding this function will not change how FCEUX interprets color values, however.
-
-
gui.savescreenshot()
-
Makes a screenshot of the FCEUX emulated screen, and saves it to the appropriate folder. Performs identically to pressing the Screenshot hotkey.
-
-
gui.savescreenshotas(string name)
-
Makes a screenshot of the FCEUX emulated screen, and saves it to the appropriate folder. However, this one receives a file name for the screenshot.
-
-
string gui.gdscreenshot()
-
-
Takes a screen shot of the image and returns it in the form of a string which can be imported by the gd library using the gd.createFromGdStr() function.
-
-
This function is provided so as to allow FCEUX to not carry a copy of the gd library itself. If you want raw RGB32 access, skip the first 11 bytes (header) and then read pixels as Alpha (always 0), Red, Green, Blue, left to right then top to bottom, range is 0-255 for all colors.
-
-
Warning: Storing screen shots in memory is not recommended. Memory usage will blow up pretty quick. One screen shot string eats around 230 KB of RAM.
Draws an image on the screen. gdimage must be in truecolor gd string format.
-
-
Transparency is fully supported. Also, if alphamul is specified then it will modulate the transparency of the image even if it's originally fully opaque. (alphamul=1.0 is normal, alphamul=0.5 is doubly transparent, alphamul=3.0 is triply opaque, etc.)
-
-
dx,dy determines the top-left corner of where the image should draw. If they are omitted, the image will draw starting at the top-left corner of the screen.
-
-
gui.gdoverlay is an actual drawing function (like gui.box and friends) and thus must be called every frame, preferably inside a gui.register'd function, if you want it to appear as a persistent image onscreen.
-
-
Here is an example that loads a PNG from file, converts it to gd string format, and draws it once on the screen:
-
local gdstr = gd.createFromPng("myimage.png"):gdStr()
-
gui.gdoverlay(gdstr)
-
-
gui.opacity(int alpha)
-
-
Scales the transparency of subsequent draw calls. An alpha of 0.0 means completely transparent, and an alpha of 1.0 means completely unchanged (opaque). Non-integer values are supported and meaningful, as are values greater than 1.0. It is not necessary to use this function (or the less-recommended gui.transparency) to perform drawing with transparency, because you can provide an alpha value in the color argument of each draw call. However, it can sometimes be convenient to be able to globally modify the drawing transparency.
-
-
gui.transparency(int trans)
-
-
Scales the transparency of subsequent draw calls. Exactly the same as gui.opacity, except the range is different: A trans of 4.0 means completely transparent, and a trans of 0.0 means completely unchanged (opaque).
-
-
function gui.register(function func)
-
-
Register a function to be called between a frame being prepared for displaying on your screen and it actually happening. Used when that 1 frame delay for rendering is not acceptable.
Brings up a modal popup dialog box (everything stops until the user dismisses it). The box displays the message tostring(msg). This function returns the name of the button the user clicked on (as a string).
-
-
type determines which buttons are on the dialog box, and it can be one of the following: 'ok', 'yesno', 'yesnocancel', 'okcancel', 'abortretryignore'.
-
type defaults to 'ok' for gui.popup, or to 'yesno' for input.popup.
-
-
icon indicates the purpose of the dialog box (or more specifically it dictates which title and icon is displayed in the box), and it can be one of the following: 'message', 'question', 'warning', 'error'.
-
icon defaults to 'message' for gui.popup, or to 'question' for input.popup.
-
-
Try to avoid using this function much if at all, because modal dialog boxes can be irritating.
-
-
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 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
-
}
-
},
-
noise:
-
{
-
volume, -- 0.0-1.0
-
short, -- true or false
-
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.
-
-
int AND(int n1, int n2, ..., int nn)
-
-
Binary logical AND of all the given integers. This function compensates for Lua's lack of it.
-
-
int OR(int n1, int n2, ..., int nn)
-
-
Binary logical OR of all the given integers. This function compensates for Lua's lack of it.
-
-
int XOR(int n1, int n2, ..., int nn)
-
-
Binary logical XOR of all the given integers. This function compensates for Lua's lack of it.
-
-
int BIT(int n1, int n2, ..., int nn)
-
-
Returns an integer with the given bits turned on. Parameters should be smaller than 31.
-
-
Appendix
-
-
On drawing
-
-
A general warning about drawing is that it is always one frame behind unless you use gui.register. This is because you tell the emulator to paint something but it will actually paint it when generating the image for the next frame. So you see your painting, except it will be on the image of the next frame. You can prevent this with gui.register because it gives you a quick chance to paint before blitting.
-
-
Dimensions & color depths you can paint in:
-
--320x239, 8bit color (confirm?)
-
256x224, 8bit color (confirm?)
-
-
On colors
-
-
Colors can be of a few types.
-
Int: use the a formula to compose the color as a number (depends on color depth)
-
String: Can either be a HTML colors, simple colors, or internal palette colors.
-
HTML string: "#rrggbb" ("#228844") or #rrggbbaa if alpha is supported.
Array: Example: {255,112,48,96} means {red=255, green=112, blue=48, alpha=96}
-
Table: Example: {r=255,g=112,b=48,a=96} means {red=255, green=112, blue=48, alpha=96}
-
Palette: Example: "P00" for Palette 00. "P3F" for palette 3F. P40-P7F are for LUA.
-
-
For transparancy use "clear".
-
+
emu.speedmode(string mode)
+
+
Set the emulator to given speed. The mode argument can be one of these:
+
- "normal"
+
- "nothrottle" (same as turbo on fceux)
+
- "turbo"
+
- "maximum"
+
+
emu.frameadvance()
+
+
Advance the emulator by one frame. It's like pressing the frame advance button once.
+
+
Most scripts use this function in their main game loop to advance frames. Note that you can also register functions by various methods that run "dead", returning control to the emulator and letting the emulator advance the frame. For most people, using frame advance in an endless while loop is easier to comprehend so I suggest starting with that. This makes more sense when creating bots. Once you move to creating auxillary libraries, try the register() methods.
+
+
emu.pause()
+
+
Pauses the emulator.
+
+
emu.unpause()
+
+
Unpauses the emulator.
+
+
emu.exec_count(int count, function func)
+
+
Calls given function, restricting its working time to given number of lua cycles. Using this method you can ensure that some heavy operation (like Lua bot) won't freeze FCEUX.
+
+
emu.exec_time(int time, function func)
+
+
Windows-only. Calls given function, restricting its working time to given number of milliseconds (approximate). Using this method you can ensure that some heavy operation (like Lua bot) won't freeze FCEUX.
Toggles the drawing of the sprites and background planes. Set to false or nil to disable a pane, anything else will draw them.
+
+
emu.message(string message)
+
+
Displays given message on screen in the standard messages position. Use gui.text() when you need to position text.
+
+
int emu.framecount()
+
+
Returns the framecount value. The frame counter runs without a movie running so this always returns a value.
+
+
int emu.lagcount()
+
+
Returns the number of lag frames encountered. Lag frames are frames where the game did not poll for input because it missed the vblank. This happens when it has to compute too much within the frame boundary. This returns the number indicated on the lag counter.
+
+
bool emu.lagged()
+
+
Returns true if currently in a lagframe, false otherwise.
+
+
bool emu.emulating()
+
+
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
+
+
Returns whether the emulator is in read-only state.
+
+
While this variable only applies to movies, it is stored as a global variable and can be modified even without a movie loaded. Hence, it is in the emu library rather than the movie library.
+
+
emu.setreadonly(bool state)
+
Alias: movie.setreadonly
+
+
Sets the read-only status to read-only if argument is true and read+write if false.
+
Note: This might result in an error if the medium of the movie file is not writeable (such as in an archive file).
+
+
While this variable only applies to movies, it is stored as a global variable and can be modified even without a movie loaded. Hence, it is in the emu library rather than the movie library.
+
+
emu.registerbefore(function func)
+
+
Registers a callback function to run immediately before each frame gets emulated. This runs after the next frame's input is known but before it's used, so this is your only chance to set the next frame's input using the next frame's would-be input. For example, if you want to make a script that filters or modifies ongoing user input, such as making the game think "left" is pressed whenever you press "right", you can do it easily with this.
+
+
Note that this is not quite the same as code that's placed before a call to emu.frameadvance. This callback runs a little later than that. Also, you cannot safely assume that this will only be called once per frame. Depending on the emulator's options, every frame may be simulated multiple times and your callback will be called once per simulation. If for some reason you need to use this callback to keep track of a stateful linear progression of things across frames then you may need to key your calculations to the results of emu.framecount.
+
+
Like other callback-registering functions provided by FCEUX, there is only one registered callback at a time per registering function per script. If you register two callbacks, the second one will replace the first, and the call to emu.registerbefore will return the old callback. You may register nil instead of a function to clear a previously-registered callback. If a script returns while it still has registered callbacks, FCEUX will keep it alive to call those callbacks when appropriate, until either the script is stopped by the user or all of the callbacks are de-registered.
+
+
emu.registerafter(function func)
+
+
Registers a callback function to run immediately after each frame gets emulated. It runs at a similar time as (and slightly before) gui.register callbacks, except unlike with gui.register it doesn't also get called again whenever the screen gets redrawn. Similar caveats as those mentioned in emu.registerbefore apply.
+
+
emu.registerexit(function func)
+
+
Registers a callback function that runs when the script stops. Whether the script stops on its own or the user tells it to stop, or even if the script crashes or the user tries to close the emulator, FCEUX will try to run whatever Lua code you put in here first. So if you want to make sure some code runs that cleans up some external resources or saves your progress to a file or just says some last words, you could put it here. (Of course, a forceful termination of the application or a crash from inside the registered exit function will still prevent the code from running.)
+
+
Suppose you write a script that registers an exit function and then enters an infinite loop. If the user clicks "Stop" your script will be forcefully stopped, but then it will start running its exit function. If your exit function enters an infinite loop too, then the user will have to click "Stop" a second time to really stop your script. That would be annoying. So try to avoid doing too much inside the exit function.
+
+
Note that restarting a script counts as stopping it and then starting it again, so doing so (either by clicking "Restart" or by editing the script while it is running) will trigger the callback. Note also that returning from a script generally does NOT count as stopping (because your script is still running or waiting to run its callback functions and thus does not stop... see here for more information), even if the exit callback is the only one you have registered.
+
+
bool emu.addgamegenie(string str)
+
+
Adds a Game Genie code to the Cheats menu. Returns false and an error message if the code can't be decoded. Returns false if the code couldn't be added. Returns true if the code already existed, or if it was added.
+
+
Usage: emu.addgamegenie("NUTANT")
+
+
Note that the Cheats Dialog Box won't show the code unless you close and reopen it.
+
+
bool emu.delgamegenie(string str)
+
+
Removes a Game Genie code from the Cheats menu. Returns false and an error message if the code can't be decoded. Returns false if the code couldn't be deleted. Returns true if the code didn't exist, or if it was deleted.
+
+
Usage: emu.delgamegenie("NUTANT")
+
+
Note that the Cheats Dialog Box won't show the code unless you close and reopen it.
+
+
emu.print(string str)
+
+
Puts a message into the Output Console area of the Lua Script control window. Useful for displaying usage instructions to the user when a script gets run.
+
+
emu.getscreenpixel(int x, int y, bool getemuscreen)
+
+
Returns the separate RGB components of the given screen pixel, and the palette. Can be 0-255 by 0-239, but NTSC only displays 0-255 x 8-231 of it. If getemuscreen is false, this gets background colors from either the screen pixel or the LUA pixels set, but LUA data may not match the information used to put the data to the screen. If getemuscreen is true, this gets background colors from anything behind an LUA screen element.
+
+
Usage is local r,g,b,palette = emu.getscreenpixel(5, 5, false) to retrieve the current red/green/blue colors and palette value of the pixel at 5x5.
+
+
Palette value can be 0-63, or 254 if there was an error.
+
+
You can avoid getting LUA data by putting the data into a function, and feeding the function name to emu.registerbefore.
+
+
FCEU library
+
+
The FCEU library is the same as the emu library. It is left in for backwards compatibility. However, the emu library is preferred.
+
+
ROM Library
+
+
rom.readbyte(int address)
+
rom.readbyteunsigned(int address)
+
+
Get an unsigned byte from the actual ROM file at the given address.
+
+
This includes the header! It's the same as opening the file in a hex-editor.
+
+
rom.readbytesigned(int address)
+
+
Get a signed byte from the actual ROM file at the given address. Returns a byte that is signed.
+
+
This includes the header! It's the same as opening the file in a hex-editor.
+
+
Memory Library
+
+
memory.readbyte(int address)
+
memory.readbyteunsigned(int address)
+
+
Get an unsigned byte from the RAM at the given address. Returns a byte regardless of emulator. The byte will always be positive.
+
+
memory.readbyterange(int address, int length)
+
+
Get a length bytes starting at the given address and return it as a string. Convert to table to access the individual bytes.
+
+
memory.readbytesigned(int address)
+
+
Get a signed byte from the RAM at the given address. Returns a byte regardless of emulator. The most significant bit will serve as the sign.
+
+
memory.writebyte(int address, int value)
+
+
Write the value to the RAM at the given address. The value is modded with 256 before writing (so writing 257 will actually write 1). Negative values allowed.
+
+
int memory.getregister(cpuregistername)
+
+
Returns the current value of the given hardware register.
+
For example, memory.getregister("pc") will return the main CPU's current Program Counter.
+
+
Valid registers are: "a", "x", "y", "s", "p", and "pc".
+
+
memory.setregister(string cpuregistername, int value)
+
+
Sets the current value of the given hardware register.
+
For example, memory.setregister("pc",0x200) will change the main CPU's current Program Counter to 0x200.
+
+
Valid registers are: "a", "x", "y", "s", "p", and "pc".
+
+
You had better know exactly what you're doing or you're probably just going to crash the game if you try to use this function. That applies to the other memory.write functions as well, but to a lesser extent.
+
+
memory.register(int address, [int size,] function func)
+
memory.registerwrite(int address, [int size,] function func)
+
+
Registers a function to be called immediately whenever the given memory address range is written to.
+
+
size is the number of bytes to "watch". For example, if size is 100 and address is 0x0200, then you will register the function across all 100 bytes from 0x0200 to 0x0263. A write to any of those bytes will trigger the function. Having callbacks on a large range of memory addresses can be expensive, so try to use the smallest range that's necessary for whatever it is you're trying to do. If you don't specify any size then it defaults to 1.
+
+
The callback function will receive two arguments, (address, size) indicating what write operation triggered the callback. If you don't care about that extra information then you can ignore it and define your callback function to not take any arguments. The value that was written is NOT passed into the callback function, but you can easily use any of the memory.read functions to retrieve it.
+
+
You may use a memory.write function from inside the callback to change the value that just got written. However, keep in mind that doing so will trigger your callback again, so you must have a "base case" such as checking to make sure that the value is not already what you want it to be before writing it. Another, more drastic option is to de-register the current callback before performing the write.
+
+
If func is nil that means to de-register any memory write callbacks that the current script has already registered on the given range of bytes.
+
+
memory.registerexec(int address, [int size,] function func)
+
memory.registerrun(int address, [int size,] function func)
+
memory.registerexecute(int address, [int size,] function func)
+
+
Registers a function to be called immediately whenever the emulated system runs code located in the given memory address range.
+
+
Besides that, most of the information about memory.register applies to this function as well.
+
+
Joypad Library
+
+
table joypad.get(int player)
+
table joypad.read(int player)
+
+
Returns a table of every game button, where each entry is true if that button is currently held (as of the last time the emulation checked), or false if it is not held. This takes keyboard inputs, not Lua. The table keys look like this (case sensitive):
+
+
up, down, left, right, A, B, start, select
+
+
Where a Lua truthvalue true means that the button is set, false means the button is unset. Note that only "false" and "nil" are considered a false value by Lua. Anything else is true, even the number 0.
+
+
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)
+
+
Returns a table of only the game buttons that are currently held. Each entry is true if that button is currently held (as of the last time the emulation checked), or nil if it is not held.
+
+
table joypad.getup(int player)
+
table joypad.readup(int player)
+
+
Returns a table of only the game buttons that are not currently held. Each entry is nil if that button is currently held (as of the last time the emulation checked), or false if it is not held.
+
+
joypad.set(int player, table input)
+
joypad.write(int player, table input)
+
+
Set the inputs for the given player. Table keys look like this (case sensitive):
+
+
up, down, left, right, A, B, start, select
+
+
There are 4 possible values: true, false, nil, and "invert".
+
true - Forces the button on
+
false - Forces the button off
+
nil - User's button press goes through unchanged
+
"invert"- Reverses the user's button press
+
+
Any string works in place of "invert". It is suggested as a convention to use "invert" for readability, but strings like "inv", "Weird switchy mechanism", "", or "true or false" works as well as "invert".
+
+
nil and "invert" exists so the script can control individual buttons of the controller without entirely blocking the user from having any control. Perhaps there is a process which can be automated by the script, like an optimal firing pattern, but the user still needs some manual control, such as moving the character around.
+
+
joypad.write left in for backwards compatibility with older versions of FCEU/FCEUX.
+
+
+
Zapper Library
+
+
table zapper.read()
+
+
Returns the zapper data
+
When no movie is loaded this input is the same as the internal mouse input (which is used to generate zapper input, as well as the arkanoid paddle).
+
+
When a movie is playing, it returns the zapper data in the movie code.
+
+
The return table consists of 3 values: x, y, and fire. x and y are the x,y coordinates of the zapper target in terms of pixels. fire represents the zapper firing. 0 = not firing, 1 = firing
+
+
+
Note: The zapper is always controller 2 on the NES so there is no player argument to this function.
+
+
+
Input Library
+
+
table input.get()
+
table input.read()
+
+
Reads input from keyboard and mouse. Returns pressed keys and the position of mouse in pixels on game screen. The function returns a table with at least two properties; table.xmouse and table.ymouse. Additionally any of these keys will be set to true if they were held at the time of executing this function:
Requests input from the user using a multiple-option message box. See gui.popup for complete usage and returns.
+
+
Savestate Library
+
+
object savestate.object(int slot = nil)
+
+
Create a new savestate object. Optionally you can save the current state to one of the predefined slots(1-10) using the range 1-9 for slots 1-9, and 10 for 0, QWERTY style. Using no number will create an "anonymous" savestate.
+
Note that this does not actually save the current state! You need to create this value and pass it on to the load and save functions in order to save it.
+
+
Anonymous savestates are temporary, memory only states. You can make them persistent by calling memory.persistent(state). Persistent anonymous states are deleted from disk once the script exits.
+
+
object savestate.create(int slot = nil)
+
+
savestate.create is identical to savestate.object, except for the numbering for predefined slots(1-10, 1 refers to slot 0, 2-10 refer to 1-9). It's being left in for compatibility with older scripts, and potentially for platforms with different internal predefined slot numbering.
+
+
savestate.save(object savestate)
+
+
Save the current state object to the given savestate. The argument is the result of savestate.create(). You can load this state back up by calling savestate.load(savestate) on the same object.
+
+
savestate.load(object savestate)
+
+
Load the the given state. The argument is the result of savestate.create() and has been passed to savestate.save() at least once.
+
+
If this savestate is not persistent and not one of the predefined states, the state will be deleted after loading.
+
+
savestate.persist(object savestate)
+
+
Set the given savestate to be persistent. It will not be deleted when you load this state but at the exit of this script instead, unless it's one of the predefined states. If it is one of the predefined savestates it will be saved as a file on disk.
+
+
savestate.registersave(function func)
+
+
Registers a callback function that runs whenever the user saves a state. This won't actually be called when the script itself makes a savestate, so none of those endless loops due to a misplaced savestate.save.
+
+
As with other callback-registering functions provided by FCEUX, there is only one registered callback at a time per registering function per script. Upon registering a second callback, the first is kicked out to make room for the second. In this case, it will return the first function instead of nil, letting you know what was kicked out. Registering nil will clear the previously-registered callback.
+
+
savestate.registerload(function func)
+
+
Registers a callback function that runs whenever the user loads a previously saved state. It's not called when the script itself loads a previous state, so don't worry about your script interrupting itself just because it's loading something.
+
+
The state's data is loaded before this function runs, so you can read the RAM immediately after the user loads a state, or check the new framecount. Particularly useful if you want to update lua's display right away instead of showing junk from before the loadstate.
+
+
savestate.loadscriptdata(int location)
+
+
Accuracy not yet confirmed.
+
+
Intended Function, according to snes9x LUA documentation:
+
Returns the data associated with the given savestate (data that was earlier returned by a registered save callback) without actually loading the rest of that savestate or calling any callbacks. location should be a save slot number.
+
+
+
Movie Library
+
+
bool movie.active()
+
+
Returns true if a movie is currently loaded and false otherwise. (This should be used to guard against Lua errors when attempting to retrieve movie information).
+
+
int movie.framecount()
+
+
Returns the current frame count. (Has the same affect as emu.framecount)
+
+
string movie.mode()
+
+
Returns the current state of movie playback. Returns one of the following:
+
+
- "record"
+
- "playback"
+
- "finished"
+
- "taseditor"
+
- nil
+
+
movie.rerecordcounting(bool counting)
+
+
Turn the rerecord counter on or off. Allows you to do some brute forcing without inflating the rerecord count.
+
+
movie.stop()
+
movie.close()
+
+
Stops movie playback. If no movie is loaded, it throws a Lua error.
+
+
int movie.length()
+
+
Returns the total number of frames of the current movie. Throws a Lua error if no movie is loaded.
+
+
string movie.name()
+
string movie.getname()
+
+
Returns the filename of the current movie with path. Throws a Lua error if no movie is loaded.
+
+
movie.getfilename()
+
+
Returns the filename of the current movie with no path. Throws a Lua error if no movie is loaded.
+
+
movie.rerecordcount()
+
+
Returns the rerecord count of the current movie. Throws a Lua error if no movie is loaded.
+
+
movie.replay()
+
movie.playbeginning()
+
+
Performs the Play from Beginning function. Movie mode is switched to read-only and the movie loaded will begin playback from frame 1.
+
+
If no movie is loaded, no error is thrown and no message appears on screen.
+
+
bool movie.readonly()
+
bool movie.getreadonly()
+
Alias: emu.getreadonly
+
+
FCEUX keeps the read-only status even without a movie loaded.
+
+
Returns whether the emulator is in read-only state.
+
+
While this variable only applies to movies, it is stored as a global variable and can be modified even without a movie loaded. Hence, it is in the emu library rather than the movie library.
+
+
movie.setreadonly(bool state)
+
Alias: emu.setreadonly
+
+
FCEUX keeps the read-only status even without a movie loaded.
+
+
Sets the read-only status to read-only if argument is true and read+write if false.
+
Note: This might result in an error if the medium of the movie file is not writeable (such as in an archive file).
+
+
While this variable only applies to movies, it is stored as a global variable and can be modified even without a movie loaded. Hence, it is in the emu library rather than the movie library.
+
+
bool movie.recording()
+
+
Returns true if there is a movie loaded and in record mode.
+
+
bool movie.playing()
+
+
Returns true if there is a movie loaded and in play mode.
+
+
bool movie.ispoweron()
+
+
Returns true if the movie recording or loaded started from 'Start'.
+
Returns false if the movie uses a save state.
+
Opposite of movie.isfromsavestate()
+
+
bool movie.isfromsavestate()
+
+
Returns true if the movie recording or loaded started from 'Now'.
+
Returns false if the movie was recorded from a reset.
+
Opposite of movie.ispoweron()
+
+
string movie.name()
+
+
If a movie is loaded it returns the name of the movie, else it throws an error.
+
+
bool movie.readonly()
+
+
Returns the state of read-only. True if in playback mode, false if in record mode.
+
+
GUI Library
+
+
gui.pixel(int x, int y, type color)
+
gui.drawpixel(int x, int y, type color)
+
gui.setpixel(int x, int y, type color)
+
gui.writepixel(int x, int y, type color)
+
+
Draw one pixel of a given color at the given position on the screen. See drawing notes and color notes at the bottom of the page.
+
+
gui.getpixel(int x, int y)
+
+
Returns the separate RGBA components of the given pixel set by gui.pixel. This only gets LUA pixels set, not background colors.
+
+
Usage is local r,g,b,a = gui.getpixel(5, 5) to retrieve the current red/green/blue/alpha values of the LUA pixel at 5x5.
+
+
See emu.getscreenpixel() for an emulator screen variant.
+
+
gui.line(int x1, int y1, int x2, int y2 [, color [, skipfirst]])
+
gui.drawline(int x1, int y1, int x2, int y2 [, color [, skipfirst]])
+
+
Draws a line between the two points. The x1,y1 coordinate specifies one end of the line segment, and the x2,y2 coordinate specifies the other end. If skipfirst is true then this function will not draw anything at the pixel x1,y1, otherwise it will. skipfirst is optional and defaults to false. The default color for the line is solid white, but you may optionally override that using a color of your choice. See also drawing notes and color notes at the bottom of the page.
+
+
gui.box(int x1, int y1, int x2, int y2 [, fillcolor [, outlinecolor]]))
+
gui.drawbox(int x1, int y1, int x2, int y2 [, fillcolor [, outlinecolor]]))
+
gui.rect(int x1, int y1, int x2, int y2 [, fillcolor [, outlinecolor]]))
+
gui.drawrect(int x1, int y1, int x2, int y2 [, fillcolor [, outlinecolor]]))
+
+
Draws a rectangle between the given coordinates of the emulator screen for one frame. The x1,y1 coordinate specifies any corner of the rectangle (preferably the top-left corner), and the x2,y2 coordinate specifies the opposite corner.
+
+
The default color for the box is transparent white with a solid white outline, but you may optionally override those using colors of your choice. Also see drawing notes and color notes.
+
+
gui.text(int x, int y, string str [, textcolor [, backcolor]])
+
gui.drawtext(int x, int y, string str [, textcolor [, backcolor]])
+
+
Draws a given string at the given position. textcolor and backcolor are optional. See 'on colors' at the end of this page for information. Using nil as the input or not including an optional field will make it use the default.
+
+
gui.parsecolor(color)
+
+
Returns the separate RGBA components of the given color.
+
For example, you can say local r,g,b,a = gui.parsecolor('orange') to retrieve the red/green/blue values of the preset color orange. (You could also omit the a in cases like this.) This uses the same conversion method that FCEUX uses internally to support the different representations of colors that the GUI library uses. Overriding this function will not change how FCEUX interprets color values, however.
+
+
gui.savescreenshot()
+
Makes a screenshot of the FCEUX emulated screen, and saves it to the appropriate folder. Performs identically to pressing the Screenshot hotkey.
+
+
gui.savescreenshotas(string name)
+
Makes a screenshot of the FCEUX emulated screen, and saves it to the appropriate folder. However, this one receives a file name for the screenshot.
+
+
string gui.gdscreenshot()
+
+
Takes a screen shot of the image and returns it in the form of a string which can be imported by the gd library using the gd.createFromGdStr() function.
+
+
This function is provided so as to allow FCEUX to not carry a copy of the gd library itself. If you want raw RGB32 access, skip the first 11 bytes (header) and then read pixels as Alpha (always 0), Red, Green, Blue, left to right then top to bottom, range is 0-255 for all colors.
+
+
Warning: Storing screen shots in memory is not recommended. Memory usage will blow up pretty quick. One screen shot string eats around 230 KB of RAM.
Draws an image on the screen. gdimage must be in truecolor gd string format.
+
+
Transparency is fully supported. Also, if alphamul is specified then it will modulate the transparency of the image even if it's originally fully opaque. (alphamul=1.0 is normal, alphamul=0.5 is doubly transparent, alphamul=3.0 is triply opaque, etc.)
+
+
dx,dy determines the top-left corner of where the image should draw. If they are omitted, the image will draw starting at the top-left corner of the screen.
+
+
gui.gdoverlay is an actual drawing function (like gui.box and friends) and thus must be called every frame, preferably inside a gui.register'd function, if you want it to appear as a persistent image onscreen.
+
+
Here is an example that loads a PNG from file, converts it to gd string format, and draws it once on the screen:
+
local gdstr = gd.createFromPng("myimage.png"):gdStr()
+
gui.gdoverlay(gdstr)
+
+
gui.opacity(int alpha)
+
+
Scales the transparency of subsequent draw calls. An alpha of 0.0 means completely transparent, and an alpha of 1.0 means completely unchanged (opaque). Non-integer values are supported and meaningful, as are values greater than 1.0. It is not necessary to use this function (or the less-recommended gui.transparency) to perform drawing with transparency, because you can provide an alpha value in the color argument of each draw call. However, it can sometimes be convenient to be able to globally modify the drawing transparency.
+
+
gui.transparency(int trans)
+
+
Scales the transparency of subsequent draw calls. Exactly the same as gui.opacity, except the range is different: A trans of 4.0 means completely transparent, and a trans of 0.0 means completely unchanged (opaque).
+
+
function gui.register(function func)
+
+
Register a function to be called between a frame being prepared for displaying on your screen and it actually happening. Used when that 1 frame delay for rendering is not acceptable.
Brings up a modal popup dialog box (everything stops until the user dismisses it). The box displays the message tostring(msg). This function returns the name of the button the user clicked on (as a string).
+
+
type determines which buttons are on the dialog box, and it can be one of the following: 'ok', 'yesno', 'yesnocancel', 'okcancel', 'abortretryignore'.
+
type defaults to 'ok' for gui.popup, or to 'yesno' for input.popup.
+
+
icon indicates the purpose of the dialog box (or more specifically it dictates which title and icon is displayed in the box), and it can be one of the following: 'message', 'question', 'warning', 'error'.
+
icon defaults to 'message' for gui.popup, or to 'question' for input.popup.
+
+
Try to avoid using this function much if at all, because modal dialog boxes can be irritating.
+
+
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 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
+
}
+
},
+
noise:
+
{
+
volume, -- 0.0-1.0
+
short, -- true or false
+
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.
+
+
int AND(int n1, int n2, ..., int nn)
+
+
Binary logical AND of all the given integers. This function compensates for Lua's lack of it.
+
+
int OR(int n1, int n2, ..., int nn)
+
+
Binary logical OR of all the given integers. This function compensates for Lua's lack of it.
+
+
int XOR(int n1, int n2, ..., int nn)
+
+
Binary logical XOR of all the given integers. This function compensates for Lua's lack of it.
+
+
int BIT(int n1, int n2, ..., int nn)
+
+
Returns an integer with the given bits turned on. Parameters should be smaller than 31.
+
+
Appendix
+
+
On drawing
+
+
A general warning about drawing is that it is always one frame behind unless you use gui.register. This is because you tell the emulator to paint something but it will actually paint it when generating the image for the next frame. So you see your painting, except it will be on the image of the next frame. You can prevent this with gui.register because it gives you a quick chance to paint before blitting.
+
+
Dimensions & color depths you can paint in:
+
--320x239, 8bit color (confirm?)
+
256x224, 8bit color (confirm?)
+
+
On colors
+
+
Colors can be of a few types.
+
Int: use the a formula to compose the color as a number (depends on color depth)
+
String: Can either be a HTML colors, simple colors, or internal palette colors.
+
HTML string: "#rrggbb" ("#228844") or #rrggbbaa if alpha is supported.
Lua is built into FCEUX as of 2.1.2, and luapack DLL files are no longer needed in this and later versions.
To run lua scripts in older versions of FCEUX, you will need the lua pack which can be found here. The .dll files must be unzipped in the same folder as fceux.exe.
-
-
Core Lua Documentation
-
+
+
Core Lua Documentation
+
If you have never programmed, you will probably want to start by learning the basic of Lua, which is too broad for the scope of this help file. Try searching on the Internet for "Lua tutorial". As of this writing, it's official homepage is http://www.lua.org/
If you are familiar with any programming language you will probably not have too much difficulty adjusting to the syntax and structure of Lua. You will probably also find useful information on the Internet.
-
-
GUI Frontend
+
+
GUI Frontend
To use a Lua script, you need to create one in a text editor. The name of the file created should end in .lua to indicate that it is a Lua script.
@@ -62,7 +72,7 @@
To end a Lua script, choose "Stop Lua Script" ***from where***.
-
FCEUX Lua Basics
+
FCEUX Lua Basics
Your script will be constructed according to the rules of Lua, but you will use FCEUX-specific functions to interact with the emulator. For example, one of the most often-used functions is emu.frameadvance() which will tell the emulator to advance exactly one frame, which is the basic unit of time on an NES.
A bit of previous programming knowledge will be useful in taking advantage of this feature, but it is certainly not a requirement. Lua is specifically written with the intention of being easier than most languages for anyone to understand and use.
To display a ram value, simply type its address into one of the address fields. The name field allows you to put a brief description of the value.
-
Prefixes
+
Prefixes
You must put in the hexi-decimal value of the address, but the value will be displayed will be decimal by default.
@@ -65,20 +75,20 @@
Use a prefix of "X" to watch a 2 byte value in hex.
-
Saving/Loading Watch files
+
Saving/Loading Watch files
You can save your addresses into watch files, as well as loading previous files using the standard save,load,new options in the File menu.
FCEUX uses the /memw folder by default but you can specify a new default folder in the Directory Override menu.
-
Options Menu
+
Options Menu
-
If you select Load on Start up, Memory watch will load up automatically when FCEU is started.
+
If you select Load on Start up, Memory watch will load up automatically when FCEU is started.
-
If you select Load Last File on Start up, the most recent file in the Recent folder will be loaded when memory watch is loaded.
+
If you select Load Last File on Start up, the most recent file in the Recent folder will be loaded when memory watch is loaded.
-
If you select Collapse to 1 Column (or press the right arrow button on the bottom left of the dialog), the memory watch dialog is reduced to just 1 column.
+
If you select Collapse to 1 Column (or press the right arrow button on the bottom left of the dialog), the memory watch dialog is reduced to just 1 column.
Frozen Memory Addresses
@@ -98,7 +108,7 @@
Reset will reset the count to 0.
-
Usage Example:
+
Usage Example:
As an example of the memory change monitoring, Let's say we are recording a movie of the game Super C and want to keep track of when the game lags.
The ram address 001C functions as a "lag flag". It will remain 0, then change to a positive value on a frame that the game lags.
2A03 CPU is a 6502-compatible CPU without the decimal mode (CLD and SED do nothing). It has an on-die sound generator, very limited DMA capability, and an input device controller that can be accessed through the 2A03 registers.
-
6502 CPU Memory Map
+
6502 CPU Memory Map
Address Range Size in bytes Notes (Page size = 256bytes)
(Hexadecimal)
@@ -157,7 +167,7 @@
Most games use the basic on board ram. The address range of this ram is $0000-$07FF. This translates to 2048 possible ram values.
-
Pages
+
Pages
This ram is broken down into 8 pages. A "page" is a block of 256 ram values.
@@ -175,26 +185,26 @@
There are always the following blocks:
-
Sprite DataBlock 2
+
Sprite DataBlock 2
I've yet to see map a game that does not use this block solely for sprite data. It will contain the "ID" numbers for all the items currently on the screen. Simply put, this data is precisely the data you see on the screen. For making TAS movies this is not useful data. If you are using cheat search and have narrowed it down your search to a few values, you can immediately discard any $02xx values.
In games with a lot of sprite data, I've seen blocks 1 & 3 also reserved for sprite data.
-
Music & Sound FXBlock 1 or 7, generally
+
Music & Sound FXBlock 1 or 7, generally
This one has more deviation, but almost all games reserve an entire block for memory allocated to the game's Music and Sound FX. Again, for TAS purposes these values are not *useful. By finding even 1 of these values, you can eliminate that block from your search possibilities. Finding which block is reserved for music is often quite simple with the Hex editor. Watching the ram values with the game playing, you can see which addresses "move to the beat".
*Actually they can come in handy for "dancing to the beat"
-
Player & Enemy Stats Blocks 1,3,4,5 generally (any or all of these)
+
Player & Enemy Stats Blocks 1,3,4,5 generally (any or all of these)
This is your "sweet spot" for movie making, as often you will be wanting to track the players speed or coordinates, enemy energy, or enemy coordinates.
These values rarely (if at all) reside outside blocks 1, 3, 4, or 5. This knowledge already reduces your search possibilities in half!
-
Rows
-
+
Rows
+
Each block is broken down into 16 "rows" of addresses. For example, in block 3, the first row is $030x ($0300-$030F).
Each row of 16* will contain similar data. For instance all x coordinates will generally be in the same row. So xxx0 might be the main characters x position. xxxx1 would be "enemy 1" (1st enemy loaded onto the screen), and so on.
@@ -203,7 +213,7 @@
*Super Mario Bros. 2 (U) is a rare example that uses rows of 10
-
Columns
+
Columns
A column would be all the values of a block that share the same last digit. So a column would be 16 addresses such as $0300, $0310, $0320, etc.
@@ -213,28 +223,28 @@
If the next row ($031x) is x positions. $0310 would be the player's x position. The remaining positions of that row would correspond to the other player/enemy x positions in line with the hp values of the previous row.
-
Example
+
Example
-
These distinctions are easier to see in a visual example. This is the enemy/player stats as they are mapped in the game Teenage Mutant Ninja Turtles.
+
These distinctions are easier to see in a visual example. This is the enemy/player stats as they are mapped in the game Teenage Mutant Ninja Turtles.
-
Block 4
-
P W1 W2 W3 E1 E2 E3 E4 E5 E6 E7 E8 X X X X
-
Sprite ID: 040x: 09 00 00 00 00 9E 9E 9E 9E 00 00 00 00 00 00 00
Many users of FCEUX do not investigate the luaScripts folder, or, for that matter, ignore lua scripting altogether. The purpose of this text is to let users know that knowing how to create lua scripts is not a requirement in using them. Indeed, there are several scripts that, if you just load them, will explain themselves enough that you don't need to know how to program at all in order to use them. Besides, they shouldn't need to be re-programmed anyway if you are to use them, for if they needed programming experience just to be used, their existence is largely defeated by that very fact!
+
Many users of FCEUX do not investigate the luaScripts folder, or, for that matter, ignore lua scripting altogether. The purpose of this text is to let users know that knowing how to create lua scripts is not a requirement in using them. Indeed, there are several scripts that, if you just load them, will explain themselves enough that you don't need to know how to program at all in order to use them. Besides, they shouldn't need to be re-programmed anyway if you are to use them, for if they needed programming experience just to be used, their existence is largely defeated by that very fact!
FCEUX itself is a program that you load. Our amazing programmers did all the work already so you don't need to program up your own FCEUX to run it, do you? The same can be said of these scripts.
-
So, open the luaScripts folder and actually take the time to look at some of these scripts. You may use a text-editing program to open these if you so wish.
+
So, open the luaScripts folder and actually take the time to look at some of these scripts. You may use a text-editing program to open these if you so wish.
-
General Purpose scripts:
+
General Purpose scripts:
These may be used with any game freely. Else, the "General" part of General Purpose doesn't apply.
-
-
Mutlitrack2.lua - Tracks future input that FCEUX promptly loses on state-load, for TAS
-
Subtitler.lua - For easier use of FCEUX's built-in subtitles for .fm2 files
-
Rewinder.lua - A way to rewind backwards by pressing a button
-
+
●
+Mutlitrack2.lua - Tracks future input that FCEUX promptly loses on state-load, for TAS
+
●
+Subtitler.lua - For easier use of FCEUX's built-in subtitles for .fm2 files
+
●
+Rewinder.lua - A way to rewind backwards by pressing a button
-
Game Specific scripts:
+
Game Specific scripts:
These scripts are built specifically for certain games. Attempting to run them while you've loaded another ROM will likely cause undesired results. The meaning of "undesired results" in this case are things like crashing the game, causing it to glitch in other ways, or having nonsense numbers and pixels show up.
-
-
BugsBunnyBirthdayBlowout.lua
-
Excitingbike.lua
-
Excitingbike-speedometeronly.lua
-
Galaxian.lua
-
Gradius-BulletHell.lua
-
Machrider.lua
-
MegamanII-LaserEyes.lua
-
PunchOutChallenge.lua
-
PunchOutStats.lua
-
PunchOutTraining.lua
-
SMB2U.lua
-
SMB3-RainbowRiding.lua
-
SMB-AreaScrambler.lua
-
SMB-CompetitionRecorder.lua
-
SMB-HitBoxes.lua
-
SMB-Jetpack.lua
-
SMB-Lives&HPDisplay.lua
-
SMB-Mouse.lua
-
SMB-Snow.lua
-
TeenageMutantNinjaTurtles.lua
-
tetris.lua
-
+
●
+BugsBunnyBirthdayBlowout.lua
+
●
+Excitingbike.lua
+
●
+Excitingbike-speedometeronly.lua
+
●
+Galaxian.lua
+
●
+Gradius-BulletHell.lua
+
●
+Machrider.lua
+
●
+MegamanII-LaserEyes.lua
+
●
+PunchOutChallenge.lua
+
●
+PunchOutStats.lua
+
●
+PunchOutTraining.lua
+
●
+SMB2U.lua
+
●
+SMB3-RainbowRiding.lua
+
●
+SMB-AreaScrambler.lua
+
●
+SMB-CompetitionRecorder.lua
+
●
+SMB-HitBoxes.lua
+
●
+SMB-Jetpack.lua
+
●
+SMB-Lives&HPDisplay.lua
+
●
+SMB-Mouse.lua
+
●
+SMB-Snow.lua
+
●
+TeenageMutantNinjaTurtles.lua
+
●
+tetris.lua
-
Auxiliary Functions scripts:
+
Auxiliary Functions scripts:
These scripts exist to make the life of programmers easier. As such, if you don't program, you may skip over these scripts. These should not be run by themselves, for they themselves probably don't have any programming to do any work usefully. It's like giving yourself a clip of bullets with no gun to use.
-
-
FRKfunctions.lua - To aid with input.get, display, and registers
-
x_functions.lua
-
shapedefs.lua - Contains a few shape-drawing functions
-
+
●
+FRKfunctions.lua - To aid with input.get, display, and registers
+
●
+x_functions.lua
+
●
+shapedefs.lua - Contains a few shape-drawing functions
Restores the color palette to its default settings.
-
NTSC Color Emulation
+
NTSC Color Emulation
If enabled, FCEUX will simulate actual NTSC signal processing. The result should be the actual colors you would see if outputting to an actual NTSC television.
TAS Editor is an overhaul in very logic of creating TAS movies (see Tool Assisted Speedruns). It is a powerful new design that takes movie making from a "recording" concept to a "creating an input file" way of thinking.
+
TAS Editor is an overhaul in the logic of creating TAS movies (see Tool Assisted Speedruns). It is a powerful new design that takes movie making from a "recording" concept to a "creating an input file" way of thinking.
In 2.1.6 release TAS Editor was completely redesigned and rewritten, incorporating new experimental ideas.
Now it also has its own Manual.
-
The tool is available in Windows version only.
+
The tool is only available in Windows version of FCEUX.
(written by Ugly Joe, author of the Text Hooker tool)
-
What is Text Hooker?
+
What is Text Hooker?
Here's a premise for you. Suppose you've pirated a bunch of Japanese NES roms and you load one of them up at random. Cool music. Cool title screen. You go to start a game, put in ???? at the name entry screen, and get to the actual game. Well, big surprise here, it's an RPG. You soon realize that you have no idea what people are saying, what shops are selling, or what your battle options are. It can be fun to trial-and-error for a while, but you're ultimately stuck in the first town. Time to load up a new ROM.
@@ -56,7 +66,7 @@
This is why I made the Text Hooker. What it allows you to do is highlight text boxes in the game and copy the kana right to the clipboard. I no longer have to look up stuff, I can just copy from the emulator, paste into the website, and go from there. While developing it, I took it a bit further by adding a (shoddy) translator right into the app, and added features such as word substitutions (so you only have to look up the word once and then the app will know what it is as soon as you copy it). What you end up with is kind of like a translator's notebook. It keeps commonly used words in a dictionary and helps you get through a Japanese game without having too much knowledge of the Japanese language.
-
What do I need to use to use it?
+
What do I need to use to use it?
Some knowledge of the Japanese language
I really can't say how much you need to know, but I suppose the more you know the better. I could be wrong, but I think you need to know at least something about the language before you can start copy/pasting translations.
@@ -71,7 +81,7 @@
Duh, you'll need a game to play. Find it yourself.
-
How do I use the Text Hooker?
+
How do I use the Text Hooker?
First of all, you need to make your table file. The text hooker doesn't use Thingy tables, but uses a modified Thingy table instead. So, make your standard Thingy table file, but save it with a .tht extension (instead of .tbl). What you need to add to the table are the dakuten and handakuten marks (tenten and maru). The byte for the dakuten mark needs to be set to tenten and the byte for the handakuten mark needs to be set to tenten. Like:
Explains the various toggle switch commands in the top two groups of commands under the Config Menu.
@@ -67,13 +77,13 @@
Toggles between NTSC (60fps) and PAL (50fps) frame rates. By default, FCEUX will detect the proper choice when loading a ROM and set the flag accordingly.
-
PPU (Sub-menu)
+
PPU (Sub-menu)
-
New PPU / Old PPU
+
New PPU / Old PPU
As of FCEUX 2.1.2, FCEUX has a new PPU core. The new PPU has improved accuracy and greater game compatibility than the previous PPU. However, some games may not work properly and there will be slight timing differences that would hurt movie compatibility. Therefore, FCEUX will still support the old PPU. Currently, Old PPU is the default setting.
-
Enable (Sub-menu)
+
Enable (Sub-menu)
Run in Background
@@ -90,23 +100,23 @@
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 back up to the last auto-save savestate.
-
Frame Adv. - Skip Lag
+
Frame Adv. - Skip Lag
This feature, if enabled, will cause the frame advance key (see movie recording) to skip over lag frames. It does this by reading the lag counter (see display) and skipping past any frames where the input is not polled.
For instance, in a 30fps game (such as double dragon), frame advance will advance 2 frames instead of 1.
-
Backup Savestates
+
Backup Savestates
-
Enabled by default. This option allows for savestate & loadstate Undo (& redo). (see context menu)
+
Enabled by default. This option allows for savestate & loadstate Undo (& redo). (see context menu)
-
Compress Savestates
+
Compress Savestates
Enabled by default. This option compresses non movie savestates.
-
Display (Sub-Menu)
+
Display (Sub-Menu)
Input Display
@@ -152,12 +162,12 @@
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
-
-
+
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
+
+
Save Config File
-
-
Saves current settings to fceux.cfg. Normally settings are not saved until FCEUX is closed.
+
+
Saves current settings to fceux.cfg. Normally settings are not saved until FCEUX is closed.
This section describes potential problems/question that could arise when using FCEUX.
-
Slow emulation / Sound crackle
+
Slow emulation / Sound crackle
FCEUX may not run well on slower CPU's. You can improve performance by setting sound to low quality in the Sound Dialog. In addition, for windowed mode try enabling hardware acceleration in the Video config dialog may also help.
-
Slow savestates when recording movies
+
Slow savestates when recording movies
On slower computers, savestates can be slow with long movies. A small speedup can be done by disabling config > enable > Backup savestates.
-
"The colors in game X do not look right"
+
"The colors in game X do not look right"
FCEUX uses the color palette of the old FCEU / FCEUXD branches. However, FCEUX comes pre-packaged with several additional color palettes. For more information see Palette config and Palette options.
-
"FCEUX won't open my ROM/File. It let's me select it in the Open File dialog then ignores my selection"
+
"FCEUX won't open my ROM/File. It let's me select it in the Open File dialog then ignores my selection"
It maybe be that the filename or pathname includes one or more on ASCII characters. Currently FCEUX does not support Unicode characters.
-
"I converted a .fcm file to .fm2 but the .fm2 desyncs"
+
"I converted a .fcm file to .fm2 but the .fm2 desyncs"
Depending on what version of FCEU / Game your .fcm was made, there maybe a number of sync issues. These are listed in detail at http://tasvideos.org/ConvertFCMtoFM2.html.
In addition, the .fm2 conversion tool has had some issues on certain operating systems including Vista and Mac.
-
"When I attempt to load a Lua script I get an error / crash"
+
"When I attempt to load a Lua script I get an error / crash"
Double check you have the Lua .dll files that came packaged with FCEUX 2.1. They must be in the /dll folder from the root directory (where fceux.exe is stored).
-
"Directdraw: Error creating secondary surface"
+
"Directdraw: Error creating secondary surface"
Currently this error will happen when attempting to do Full screen mode on Windows Vista. In addition, there has been one reported case of this happening on the 32-bit version of Windows XP. This is a known issue with FCEUX that has not yet been resolved.
-
"Can't find FDS Bios image when I attempt to load a .fds game!"
+
"Can't find FDS Bios image when I attempt to load a .fds game!"
FCEUX requires the FDS Bios to be named disksys.rom. It must be located in the root directory (where fceux.exe is stored) or in the folder of the FDS Directory override (see Directory overrides).
In addition, there are some bad versions of disksys.rom. The one FDS requires is 8192 bytes.
-
"How can I use Netplay / Where can I get FCEU Server?"
+
"How can I use Netplay / Where can I get FCEU Server?"
Currently FCEUX is not compatible with the FCEU-server code. This is a known issue and will be resolved in a future release.
-
"I have a Game Genie rom, how can I use it with FCEUX?"
+
"I have a Game Genie rom, how can I use it with FCEUX?"
While FCEUX has a Game Genie code converter, you can also use game genie codes with the game genie rom. It must be named gg.rom and be placed in the root directory (where fceux.exe is stored). You must also check NES > Game Genie in the main menu.
If full screen is causing problems, checking this might fix it.
-
Custom Video Mode
+
Custom Video Mode
Mode:
Sets the image size during full screen mode, if custom is selected under Full Screen Settings.
@@ -103,7 +113,7 @@
This is checked by default. Slower computers my experience slow emulation and should uncheck this option. The video will be blurred somewhat with this option checked.
-
Drawing Area
+
Drawing Area
First Line
Sets the first scan line for NTSC and PAL Modes. This should be left on the default of 8.
@@ -114,7 +124,7 @@
Clip Left and Right Sides (8 columns each)
If enabled, 8 pixels from each side of the windows will be removed. Who knows why you would want to!
-
Emulation
+
Emulation
Allow More than 8 sprites per scanline.
On real NES hardware, more than 8 sprites on the screen causes flickering. Enabling this can cause less flickering by allowing more sprites to be visible at once. If you prefer to say "true" to NES hardware, this should not be checked.
The 2.1 new release fixes some bugs of 2.1.0a, improves the accuracy of the sound core, and adds useability enhancements to the windows port.
Common - Bug fixes
-
-
Fixed reported issue 2746924 (md5_asciistr() doesn't produce correct string)
-
Made default save slot 0 instead of 1
-
+
●
+Fixed reported issue 2746924 (md5_asciistr() doesn't produce correct string)
+
●
+Made default save slot 0 instead of 1
Improved Sound core/PPU
-
-
Fixed the noise value, it seems that the noise logic was shifting the values to the left by 1 when reloading, but this doesn't work for PAL since one of the PAL reload value is odd, so fix the logic and used the old tables. Revert a stupid CPU ignore logic in PPU. Sorry about that.
-
Updated with the correct values for the noise and DMC table,
-
Fixed the CPU unofficial opcode ATX, ORing with correct constant $FF instead of $EE, as tested by blargg's. These fixes passes the IRQ flags test from blargg, and also one more opcode test from blargg's cpu.nes test.
-
Square 1 & square 2 volume controls no longer backwards
-
Length counters for APU now correct variables
-
+
●
+Fixed the noise value, it seems that the noise logic was shifting the values to the left by 1 when reloading, but this doesn't work for PAL since one of the PAL reload value is odd, so fix the logic and used the old tables. Revert a stupid CPU ignore logic in PPU. Sorry about that.
+
●
+Updated with the correct values for the noise and DMC table,
+
●
+Fixed the CPU unofficial opcode ATX, ORing with correct constant $FF instead of $EE, as tested by blargg's. These fixes passes the IRQ flags test from blargg, and also one more opcode test from blargg's cpu.nes test.
NewPPU (still experimental, enabled by setting newppu 1 in the config file)
-
-
Added experimental $2004 reading support to play micro machines with (little) shakes, and fixed some timing in the new PPU.
-
Added palette reading cases for the new PPU.
-
+
●
+Added experimental $2004 reading support to play micro machines with (little) shakes, and fixed some timing in the new PPU.
+
●
+Added palette reading cases for the new PPU.
Win32
Minor Bug fixes
-
-
Replay movie dialog - Stop movie at frame x feature - fixed off by 1 error on the stop frame number
-
Hex Editor - changed ROM values again dsiplay as red, saved in the config as RomFreezeColor
-
Fixed bug in memory watch that would make the first watch value drawn in the wrong place if watch file was full
-
Debugger - Step type functions now update other dialogs such as ppu, nametable, code/data, trace logger, etc.
-
"Disable screen saver" gui option now also diables the monitor powersave
-
Recent menus - no longer crash if item no longer exists, instead it ask the user if they want to remove the item from the list
-
Sound Config Dialog - When sound is off, all controls are grayed out
-
Memory Watch - fixed a regression made in 2.0.1 that broke the Save As menu item
-
Memory Watch - save menu item is grayed if file hasn't changed
-
+
●
+Replay movie dialog - Stop movie at frame x feature - fixed off by 1 error on the stop frame number
+
●
+Hex Editor - changed ROM values again dsiplay as red, saved in the config as RomFreezeColor
+
●
+Fixed bug in memory watch that would make the first watch value drawn in the wrong place if watch file was full
+
●
+Debugger - Step type functions now update other dialogs such as ppu, nametable, code/data, trace logger, etc.
+
●
+"Disable screen saver" gui option now also diables the monitor powersave
+
●
+Recent menus - no longer crash if item no longer exists, instead it ask the user if they want to remove the item from the list
+
●
+Sound Config Dialog - When sound is off, all controls are grayed out
+
●
+Memory Watch - fixed a regression made in 2.0.1 that broke the Save As menu item
+
●
+Memory Watch - save menu item is grayed if file hasn't changed
GUI/Enhancements
-
-
Last save slot used is stored in the config file
-
Made fullscreen toggle (Alt+Enter) remappable
-
Hex editor - Reverted fixedFontHeight to 13 instead of 14. Gave the option of adjusting the height by modifying RowHeightBorder in the .cfg file
-
Hex Editor - allowed the user to customize the color scheme by use of RGB values stored in the .cfg file
-
Hex editor - freeze/unfreeze ram addresses now causes the colors to update immediately, but only with groups of addresses highlighted at once (single ones still don't yet update)
-
Hex Editor - Save Rom As... menu option enabled and implemented
-
Window caption shows the name of the ROM loaded
-
Recent Movie Menu added
-
Load Last Movie context menu item added
-
Save Movie As... context menu item (for when a movie is loaded in read+write mode)
-
Drag & Drop support for all files related to FCEUX including:
-
+
●
+Last save slot used is stored in the config file
+
●
+Made fullscreen toggle (Alt+Enter) remappable
+
●
+Hex editor - Reverted fixedFontHeight to 13 instead of 14. Gave the option of adjusting the height by modifying RowHeightBorder in the .cfg file
+
●
+Hex Editor - allowed the user to customize the color scheme by use of RGB values stored in the .cfg file
+
●
+Hex editor - freeze/unfreeze ram addresses now causes the colors to update immediately, but only with groups of addresses highlighted at once (single ones still don't yet update)
+
●
+Hex Editor - Save Rom As... menu option enabled and implemented
+
●
+Window caption shows the name of the ROM loaded
+
●
+Recent Movie Menu added
+
●
+Load Last Movie context menu item added
+
●
+Save Movie As... context menu item (for when a movie is loaded in read+write mode)
+
●
+Drag & Drop support for all files related to FCEUX including:
.fcm (autoconverts to .fm2 and begins movie playback)
Savestates
Palette files (.pal)
-
-
Commandline - -palette commandline option
-
Memory Watch - option to bind to main window, if checked it gives GENS dialog style control, where there is no extra task bar item, and it minimizes when FCEUX is minimized
-
+
●
+Commandline - -palette commandline option
+
●
+Memory Watch - option to bind to main window, if checked it gives GENS dialog style control, where there is no extra task bar item, and it minimizes when FCEUX is minimized
SDL
-
-
added --subtitles
-
fixed Four Score movie playback
-
added --ripsubs for converting fm2 movie subtitles to an srt file
-
Lua is optional again, fixed the real issue
-
Lua is NO longer optional, so the SConscripts have been updated to reflect that change. This fixes the mysterious non-working input issue.
-
implemented saving/loading a savestate from a specific file on Alt+S/L
-
implemented starting an FM2 movie on Alt+R
-
added --pauseframe to pause movie playback on frame x
-
dropped UTFConverter.c from SDL build
-
added hotkey Q for toggling read-only/read+write movie playback
-
+
●
+added --subtitles
+
●
+fixed Four Score movie playback
+
●
+added --ripsubs for converting fm2 movie subtitles to an srt file
+
●
+Lua is optional again, fixed the real issue
+
●
+Lua is NO longer optional, so the SConscripts have been updated to reflect that change. This fixes the mysterious non-working input issue.
+
●
+implemented saving/loading a savestate from a specific file on Alt+S/L
+
●
+implemented starting an FM2 movie on Alt+R
+
●
+added --pauseframe to pause movie playback on frame x
+
●
+dropped UTFConverter.c from SDL build
+
●
+added hotkey Q for toggling read-only/read+write movie playback
The 2.1.2 release fixes some bugs of 2.1.0a, increases game compatibility, launches a new PPU core, and adds usability enhancements to the windows port.
Common
-
-
New PPU is now functional! You can access it by changing the newPPU flag in the config file. Windows users can access it from Config > PPU > New PPU
-
Dragon Ball Z 3 now playable again
-
Fixed action 52 game that was broken in post-FCEUX 2.0.3 versions
-
Mapper 253 mostly implemented
-
Mapper 43 fixed bug
-
+
●
+New PPU is now functional! You can access it by changing the newPPU flag in the config file. Windows users can access it from Config > PPU > New PPU
+
●
+Dragon Ball Z 3 now playable again
+
●
+Fixed action 52 game that was broken in post-FCEUX 2.0.3 versions
+
●
+Mapper 253 mostly implemented
+
●
+Mapper 43 fixed bug
Win32
-
-
Imported NSF features from FCEUXDSP-NSF. Debugging tools are now compatible with NSF files.
-
Movies now record FDS disk swapping commands
-
Movie play dialog displays movie time based on ~60.1 (~50.1 PAL) instead of 60 & 50
-
Ram Watch and Ram Search dialogs imported from GENS rerecording
-
Ram Filter dialog removed (now redundant compared to both cheat search and ram search)
-
Lua script window ported from GENS
-
Fix for the directory overrides bug that caused overrides to reset
-
Debugger: .deb file saving/loading restored
-
"Save config file" menu item
-
"New PPU" menu item
-
+
●
+Imported NSF features from FCEUXDSP-NSF. Debugging tools are now compatible with NSF files.
+
●
+Movies now record FDS disk swapping commands
+
●
+Movie play dialog displays movie time based on ~60.1 (~50.1 PAL) instead of 60 & 50
+
●
+Ram Watch and Ram Search dialogs imported from GENS rerecording
+
●
+Ram Filter dialog removed (now redundant compared to both cheat search and ram search)
+
●
+Lua script window ported from GENS
+
●
+Fix for the directory overrides bug that caused overrides to reset
+
●
+Debugger: .deb file saving/loading restored
+
●
+"Save config file" menu item
+
●
+"New PPU" menu item
Minor Bug fixes
-
-
Minor fixes to recent menus
-
Fixed a bug that prevented the Map Hotkeys dialog's X button from closing the dialog
-
Restored DPCM Logging when Code/Data Logger is active
-
Memory watch - Save Changes Prompt - clicking save will default to quicksave first and save as 2nd (instead of always defaulting to save as)
-
Made Trace Logger refresh adequately when using stepping options in the debugger.
-
+
●
+Minor fixes to recent menus
+
●
+Fixed a bug that prevented the Map Hotkeys dialog's X button from closing the dialog
+
●
+Restored DPCM Logging when Code/Data Logger is active
+
●
+Memory watch - Save Changes Prompt - clicking save will default to quicksave first and save as 2nd (instead of always defaulting to save as)
+
●
+Made Trace Logger refresh adequately when using stepping options in the debugger.
Lua
-
-
joypad.set() fixed. True,False, and Nil now work properly for all buttons. In addition there is a new "invert" option.
The 2.1.3 release fixes some bugs of 2.1.2, increases game compatibility, and adds usability enhancements to the windows port and adds a GUI to the SDL port.
Common
-
-
Fixed mappers 82, 25, 21, and 18. Games such as SD Kiji Blader, Ganbare Goemon Gaiden, and Ganbare Goemon Gaiden 2, Jajamaru Gekimadden are now playable
-
Fixes for mappers 253 & 226 - fixes games such as Fire Emblem (J) and Fire Emblem Gaiden (J)
-
Fix crashing on game loading for any battery backed ROMs with mappers from MapInitTab (fixes Esper Dream 2 - Aratanaru Tatakai (J)
-
FDS - show name of missing bios file in error message
-
NewPPU - fixed sprite hit before 255 and for non transparent hits only, thanks to dwedit for providing the fix
-
.fm2 file format header now has an FDS flag
-
+
●
+Fixed mappers 82, 25, 21, and 18. Games such as SD Kiji Blader, Ganbare Goemon Gaiden, and Ganbare Goemon Gaiden 2, Jajamaru Gekimadden are now playable
+
●
+Fixes for mappers 253 & 226 - fixes games such as Fire Emblem (J) and Fire Emblem Gaiden (J)
+
●
+Fix crashing on game loading for any battery backed ROMs with mappers from MapInitTab (fixes Esper Dream 2 - Aratanaru Tatakai (J)
+
●
+FDS - show name of missing bios file in error message
+
●
+NewPPU - fixed sprite hit before 255 and for non transparent hits only, thanks to dwedit for providing the fix
+
●
+.fm2 file format header now has an FDS flag
SDL
-
-
A GUI! A graphic user interface (using GTK) with many basic menu options
-
ported to SDL 1.3; compatibility maintained with 1.2
-
unix netplay is now functional; gtk network gui created
-
now prints the name of the mapper on ROM load
-
fixed dpad/joyhat support
-
VS unisystem keys now configable
-
changed default hotkeys and keys to match Win32
-
disallow --inputcfg gamepad0 and gamepad5
-
+
●
+A GUI! A graphic user interface (using GTK) with many basic menu options
+
●
+ported to SDL 1.3; compatibility maintained with 1.2
+
●
+unix netplay is now functional; gtk network gui created
+
●
+now prints the name of the mapper on ROM load
+
●
+fixed dpad/joyhat support
+
●
+VS unisystem keys now configable
+
●
+changed default hotkeys and keys to match Win32
+
●
+disallow --inputcfg gamepad0 and gamepad5
Win32
-
-
Made savestate backups optional (config - enable - backup savestates)
-
Made savestate compression togglable (config - enable - compress savestates)
-
Cheats dialog - Pause while active checkbox
-
Cheats dialog - Toggling a cheat in the cheats list now updates the active cheats count
-
Debugger - added an auto-load feature
-
Debugger - Fix so it doesn't crash if unminimized with no game loaded
-
Closing minimized windows no longer moves them the next time they get opened
-
Lua console - added a menu
-
Lua console - filename updates when lua scripts are dragged to emulator or recent filenames invoked
-
Name Table Viewer - Fix for use with New PPU
-
Trace Logger - Trace logger now logs the values of the stack pointer register
-
If a .fm2 file is drag and dropped with no ROM load, the open ROM dialog will appear
-
disable movie messages menu item
-
Added more window positions bounds checks. Accounts for -32000 positions and less out-of-range too
New lua functions: gui.parsecolor(), joypad.getup(), joypad.getdown(), emu.emulating()
-
Change gui.line, gui.box, joypad.get to function consistently with other lua emulators such as GENS rerecording
-
fixed zapper.read() to read movie data if a movie is playing. Also changed the struct values to x,y,fire. This breaks lua scripts that used it previous, sorry
-
gui.text() now has out of bounds checking
-
Lua no longer unpauses the emulator when a script is loaded
●
+Change gui.line, gui.box, joypad.get to function consistently with other lua emulators such as GENS rerecording
+
●
+fixed zapper.read() to read movie data if a movie is playing. Also changed the struct values to x,y,fire. This breaks lua scripts that used it previous, sorry
+
●
+gui.text() now has out of bounds checking
+
●
+Lua no longer unpauses the emulator when a script is loaded
The 2.1.4 release fixes many bugs and adds new features compared to 2.1.3. In addition it also fixes up the movie code significantly; fixing implementation problems, loading speed, adding new features, and fixing bugs.
Common
-
-
Added microphone support option. When enabled, Port 2 Start activates the Microphone
-
Prevent .zip files containing no recognized files from causing crash
-
Autohold - Added player 3 and 4 to autohold notification window, labeled controller input
-
mapper 19 savestate fix mirroring for "Dream Master (J)" corrected to "four-screen" by CRC check
-
Disable auto-savestates during turbo
-
Fixed so Gotcha! auto-enables the zapper
-
Autohold - Added player 3 and 4 to autohold notification window, labeled controller input
-
+
●
+Added microphone support option. When enabled, Port 2 Start activates the Microphone
+
●
+Prevent .zip files containing no recognized files from causing crash
+
●
+Autohold - Added player 3 and 4 to autohold notification window, labeled controller input
+
●
+mapper 19 savestate fix mirroring for "Dream Master (J)" corrected to "four-screen" by CRC check
+
●
+Disable auto-savestates during turbo
+
●
+Fixed so Gotcha! auto-enables the zapper
+
●
+Autohold - Added player 3 and 4 to autohold notification window, labeled controller input
Movies
-
-
Fully implemented "bulletproof" read-only
-
Movie code now fully conforms to the Savestate section of the Laws of TAS
-
Fixed a potential desync that plays out an extra frame without an update to the frame count involving heavy lua use, joypad.get, and a loadstate
-
Movie support for microphone
-
Movies now have a "finished" mode. If a playback stops the movie isn't cleared from memory, and can be replayed or a state loaded Similar functionality as DeSmuME and GENS rerecording
-
New PPU flag in movie headers (doesn't change an emulators PPU state when loading a movie)
-
Much faster movie loading and movie-savestate loading
-
Made gamepad 2 off by default (so less movies should have unused player 2 data)
-
Implemented a "full savestate-movie load" mode similar to the implementation in VBA-rr and SNES9x-rr. In this mode loading a savestate in read+write doesn't truncate the movie to its frame count immediately. Instead it waits until input is recording into the movie (next frame). For win32 this feature is togglable in movie options and the context menu. For SDL this is off by default and a toggle will need to be added
-
Movie + loadstate errors are handled more gracefully now, with more informative error messages and the movie doesn't have to stop if backups are enabled
-
Fix PlayMovieFromBeginning when using a movie that starts from savestate
-
+
●
+Fully implemented "bulletproof" read-only
+
●
+Movie code now fully conforms to the Savestate section of the Laws of TAS
+
●
+Fixed a potential desync that plays out an extra frame without an update to the frame count involving heavy lua use, joypad.get, and a loadstate
+
●
+Movie support for microphone
+
●
+Movies now have a "finished" mode. If a playback stops the movie isn't cleared from memory, and can be replayed or a state loaded Similar functionality as DeSmuME and GENS rerecording
+
●
+New PPU flag in movie headers (doesn't change an emulators PPU state when loading a movie)
+
●
+Much faster movie loading and movie-savestate loading
+
●
+Made gamepad 2 off by default (so less movies should have unused player 2 data)
+
●
+Implemented a "full savestate-movie load" mode similar to the implementation in VBA-rr and SNES9x-rr. In this mode loading a savestate in read+write doesn't truncate the movie to its frame count immediately. Instead it waits until input is recording into the movie (next frame). For win32 this feature is togglable in movie options and the context menu. For SDL this is off by default and a toggle will need to be added
+
●
+Movie + loadstate errors are handled more gracefully now, with more informative error messages and the movie doesn't have to stop if backups are enabled
+
●
+Fix PlayMovieFromBeginning when using a movie that starts from savestate
Lua
-
-
fix bug that caused zapper.read() to crash when movie playback ends
-
Win32 - Added option for palette selection as color for LUA colors. Included is a LUA script to display all choices with the value used to pick displayed color
-
+
●
+fix bug that caused zapper.read() to crash when movie playback ends
+
●
+Win32 - Added option for palette selection as color for LUA colors. Included is a LUA script to display all choices with the value used to pick displayed color
New Lua functions
-
-
movie.ispoweron()
-
movie.isfromsavestate()
-
emu.addgamegenie()
-
emu.delgamegenie()
-
savestate.object() which is savestate.create() with intuitive numbering under windows
-
gui.getpixel() which gets any gui.pixel() set pixel colors, and possibly other functions
-
emu.getscreenpixel() which gets the RGB and Palette of any pixel on the screen
-
lua function movie.getfilename() which returns the current movie filename without the path included
-
+
●
+movie.ispoweron()
+
●
+movie.isfromsavestate()
+
●
+emu.addgamegenie()
+
●
+emu.delgamegenie()
+
●
+savestate.object() which is savestate.create() with intuitive numbering under windows
+
●
+gui.getpixel() which gets any gui.pixel() set pixel colors, and possibly other functions
+
●
+emu.getscreenpixel() which gets the RGB and Palette of any pixel on the screen
+
●
+lua function movie.getfilename() which returns the current movie filename without the path included
Input Display
-
-
Input display updates on loadstate
-
Input display overhaul that uses different colors for different input contexts
-
Input display now shows both currently pressed buttons and buttons held the previous frame
-
+
●
+Input display updates on loadstate
+
●
+Input display overhaul that uses different colors for different input contexts
+
●
+Input display now shows both currently pressed buttons and buttons held the previous frame
Win32
-
-
Added NTSC 2x scalar option with some CFG config options of it's own Added Ram Search hotkeys for the first 6 search types in the list
-
Add Cheat buttons for Ram Search and Ram Watch
-
With special scaler in window mode, it's possible to resize to anything above the minimum.
-
Recording a new movie adds it to recent movies list
-
Replay dialog, when selecting a movie in a relative path (.\movies for example), the recent movies list stores an absolute path instead
-
Replay dialog shows PAL flag and New PPU flags
-
CDLogger - fixed bug preventing correct interrupt vectors from logging
-
Memwatch - ignore spaces at the beginnign of an address in the address boxes
-
Replay dialog - fix bug that was causing it to always report savestate movies as soft-reset
-
+
●
+Added NTSC 2x scalar option with some CFG config options of it's own Added Ram Search hotkeys for the first 6 search types in the list
+
●
+Add Cheat buttons for Ram Search and Ram Watch
+
●
+With special scaler in window mode, it's possible to resize to anything above the minimum.
+
●
+Recording a new movie adds it to recent movies list
+
●
+Replay dialog, when selecting a movie in a relative path (.\movies for example), the recent movies list stores an absolute path instead
●
+Memwatch - ignore spaces at the beginnign of an address in the address boxes
+
●
+Replay dialog - fix bug that was causing it to always report savestate movies as soft-reset
Debugger
-
-
Added conditional debugging option 'K', for bank PC is on
-
Fixed bug involving pausing emulation outside of the debugger, then trying to use the debugger commands, and having the CPU registers become corrupted
-
Made debugger able to break on and distinguish Stack reads/writes
-
+
●
+Added conditional debugging option 'K', for bank PC is on
+
●
+Fixed bug involving pausing emulation outside of the debugger, then trying to use the debugger commands, and having the CPU registers become corrupted
+
●
+Made debugger able to break on and distinguish Stack reads/writes
Hex Editor
-
-
Added "Goto" command
-
Made the Hex Editor display the Frozen, Bookmarked, etc. status of the selected address, and made the Frozen color override the Bookmarked color.
-
+
●
+Added "Goto" command
+
●
+Made the Hex Editor display the Frozen, Bookmarked, etc. status of the selected address, and made the Frozen color override the Bookmarked color.
Cheat Search
-
-
Made enabling/disabling cheats no longer deselect the selected cheat
-
Added context menu to Cheat Dialog Cheat Listbox, populated list with Toggle Cheat, Poke Cheat Value, and Goto In Hex Editor
-
Enabled multi-select for Cheat menu to allow multiple toggles and deletes
-
Made cheat menu's Pause When Active effect immediate
-
+
●
+Made enabling/disabling cheats no longer deselect the selected cheat
+
●
+Added context menu to Cheat Dialog Cheat Listbox, populated list with Toggle Cheat, Poke Cheat Value, and Goto In Hex Editor
+
●
+Enabled multi-select for Cheat menu to allow multiple toggles and deletes
+
●
+Made cheat menu's Pause When Active effect immediate
GUI
-
-
Added Tools - GUI option to partially disable visual themes, so the emulator can be made to look like it did in 2.1.1 and earlier releases. Drag & Drop - if dropping a .fcm with no ROM loaded, prompt for one (same functionality that was added to .fm2 files)
-
Added single-instance mode, which makes starting a second copy of FCEUX load the file into the first, then exit.Mode off by default, togglable under Config - GUI
-
+
●
+Added Tools - GUI option to partially disable visual themes, so the emulator can be made to look like it did in 2.1.1 and earlier releases. Drag & Drop - if dropping a .fcm with no ROM loaded, prompt for one (same functionality that was added to .fm2 files)
+
●
+Added single-instance mode, which makes starting a second copy of FCEUX load the file into the first, then exit.Mode off by default, togglable under Config - GUI
The 2.1.5 release fixes a lot of bugs and brings various improvements to the prior 2.1.4a release. In addition, the SDL port has improved signficantly; completely overhauling the GTK2 GUI, fixing many sound issues, and fixing a variety of bugs.
Common
-
-
Fixed compatibility issue with Young Indiana Jones Chronicals.
-
Fixed bug in new PPU that made some intensify bits not get applied to output (fixed flashing siren screen in Werefolf).
-
Fix many segmentation faults related to file handling.
-
+
●
+Fixed compatibility issue with Young Indiana Jones Chronicals.
+
●
+Fixed bug in new PPU that made some intensify bits not get applied to output (fixed flashing siren screen in Werefolf).
+
●
+Fix many segmentation faults related to file handling.
Movies
-
-
Slight performance increase when loading movies.
-
Fixed read-only loadstate error messages and logic.
-
+
●
+Slight performance increase when loading movies.
+
●
+Fixed read-only loadstate error messages and logic.
Lua
-
-
Lua socket added to built-in lua library.
-
Fixed speed.mode() function so that normal turns off turbo.
-
+
●
+Lua socket added to built-in lua library.
+
●
+Fixed speed.mode() function so that normal turns off turbo.
New Lua functions
-
-
gui.savescreenshotas()
-
sound.get()
-
+
●
+gui.savescreenshotas()
+
●
+sound.get()
Win32
-
-
Fixed bug where PPU toggling toggled the Game Genie as well
-
Fixed some minor GUI issues.
-
Added avi capture commandline argument and related parameters.
-
Fix input selection for Famicom Expansion port.
-
+
●
+Fixed bug where PPU toggling toggled the Game Genie as well
+
●
+Fixed some minor GUI issues.
+
●
+Added avi capture commandline argument and related parameters.
+
●
+Fix input selection for Famicom Expansion port.
Debugger
-
-
Fixed Ram Search to only display valid RAM addresses (0000-07FF and 6000-7FFF).
-
Fixed crash when re-opening debugging window.
-
+
●
+Fixed Ram Search to only display valid RAM addresses (0000-07FF and 6000-7FFF).
+
●
+Fixed crash when re-opening debugging window.
Hex Editor
-
-
Added a confirmation prompt before removing all bookmarks.
-
+
●
+Added a confirmation prompt before removing all bookmarks.
Ram Watch / Ram Search
-
-
Fixed the multiple selection of watches.
-
Added support for Multiple selection of addresses in RamWatch Fixed issue with restoration of the selection range in RamWatch.
-
+
●
+Fixed the multiple selection of watches.
+
●
+Added support for Multiple selection of addresses in RamWatch Fixed issue with restoration of the selection range in RamWatch.
TasEdit
-
-
General cleanup.
-
Fixed crash when truncating while turbo was enabled.
-
Invalidate greenzone when re-recording earlier portions of a movie.
-
+
●
+General cleanup.
+
●
+Fixed crash when truncating while turbo was enabled.
+
●
+Invalidate greenzone when re-recording earlier portions of a movie.
GUI
-
-
Added "SaveStateAs" menu item.
-
Display movie name at the top of the main window.
-
+
●
+Added "SaveStateAs" menu item.
+
●
+Display movie name at the top of the main window.
The 2.1.6 release fixes many bugs and adds new features to the prior 2.1.5 release. The most significant feature is new TAS Editor v1.0, created to boost efficiency and ease of Tool-Assisted Speedrunning.
Common
-
-
Fixed crash when using machine with no sound card
-
Fixed long savestate messages containing path
-
Soft reset and power switch messages
-
All onscreen messages are now logged to Message Log
-
Improved hud text rendering wrapping
-
Fixed wrong default palette entry
-
+
●
+Fixed crash when using machine with no sound card
+
●
+Fixed graphic tearing with vertical sync enabled in windowed mode
+
●
+Fixed long savestate messages containing path
+
●
+Soft reset and power switch messages
+
●
+All onscreen messages are now logged to Message Log
+
●
+Improved hud text rendering wrapping
+
●
+Fixed wrong default palette entry
Emulation
-
-
A bit of latest mapper changes from fceu-mm
-
PAL/NTSC noise bug fixed
-
Fixed bus conflict emulation, no kage no densetsu bug anymore
-
Straighten out bandai m159/m016 handling and add valid null-EEPROM emulation to get those games booting.
-
Fixed newppu bug which prevented metroid from booting, CHR RAM was not getting initialized to anything
-
Newppu - fix bug in scroll reg logic causing mis-scrolls in p'radikus conflict
-
Datalatch mapper - fix bug where wramless games would be able to do something to unmapped host emulator memory
-
fixed mappers 242, 227, 115, 248, 12, 164
-
+
●
+PAL/NTSC noise bug fixed
+
●
+Fixed newppu bug which prevented metroid from booting, CHR RAM was not getting initialized to anything
+
●
+Newppu - fix bug in scroll reg logic causing mis-scrolls in p'radikus conflict
●
+Straighten out bandai m159/m016 handling and add valid null-EEPROM emulation to get those games booting.
+
●
+Add ability for CNROM games to choose whether they have bus conflicts (fixes Colorful Dragon (Unl) (Sachen), since it flakes out if bus conflicts are emulated)
+
●
+Fixed bus conflict emulation, no kage no densetsu bug anymore
+
●
+Datalatch mapper - fix bug where wramless games would be able to do something to unmapped host emulator memory
Movies
-
-
Fixed old bug in "Play Movie From Beginning"
-
Added support for HUD recording in AVI dumping
-
Rerecord counter display
-
Config->Movie options->Always suggest Read-Only replay (for Replay dialog). No more accidental rewrites!
-
Removed "Lag Counter Reset" hotkey, as it was obsolete since FCEUX 2.0.2
-
+
●
+Fixed old bug in "Play Movie From Beginning"
+
●
+Added support for HUD recording in AVI dumping
+
●
+Rerecord counter display
+
●
+Config->Movie options->Always suggest Read-Only replay (for Replay dialog). No more accidental rewrites!
+
●
+Removed "Lag Counter Reset" hotkey, as it was obsolete since FCEUX 2.0.2
Lua
-
-
Fixed lua drawing alpha blending
-
New library: taseditor (Windows-only) - contains 24 functions, see taseditor.chm
Lua console now gets proper file path when selecting a file from the recent menu
-
Fixed graphic tearing with vertical sync enabled in windowed mode
-
Fixed crashes and bugs caused by 2.1.5 allowing hotkeys without ROM loaded
-
Fixed context menus to use rightclicks in context menus correctly
-
Reload hotkey now also supports removing invalid filenames in Recent ROMs
-
Replay dialog speedup, it doesn't search for movies in fceux root folder anymore
-
+
●
+Lua console now gets proper file path when selecting a file from the recent menu
+
●
+Fixed crashes and bugs caused by 2.1.5 allowing hotkeys without ROM loaded
+
●
+Fixed context menus to use rightclicks in context menus correctly
+
●
+Reload hotkey now also supports removing invalid filenames in Recent ROMs
+
●
+Replay dialog speedup, it doesn't search for movies in fceux root folder anymore
Debugger
-
-
Fixed mysterious out of bounds condition while editing breakpoints
-
+
●
+Fixed mysterious out of bounds condition while editing breakpoints
Cheats
-
-
Don't lose cheat compare value when toggle cheat enables through UI
-
+
●
+Don't lose cheat compare value when toggle cheat enables through UI
Ram Watch / Ram Search
-
-
Updating list when emulator is paused (on Power or when resetting search)
-
Fixed loading Data Size and Data Type from a .wch, now corrupted .wch won't crash
-
+
●
+Updating list when emulator is paused (on Power or when resetting search)
+
●
+Fixed loading Data Size and Data Type from a .wch, now corrupted .wch won't crash
TAS Editor
-
-
Completely rewritten tool with brand new architecture and design. Too many changes to enlist, see taseditor.chm
-
+
●
+Completely rewritten tool with brand new architecture and design. Too many changes to enlist, see taseditor.chm
GUI
-
-
Loading TAS Editor projects (*.fm3) by Drag & Drop
-
Fixed bug with Input Config not displaying some key names
-
Changed some checkboxes to radiobuttons in menu
-
Launch tools hotkeys shown in menu
-
+
●
+Support multibyte languages for opening roms, at least through drag&drop
+
●
+Loading TAS Editor projects (*.fm3) by drag&drop
+
●
+Fixed bug with Input Config not displaying some key names
+
●
+Changed some checkboxes to radiobuttons in menu
+
●
+Launch tools hotkeys shown in menu; general cleanup of menu/settings
diff --git a/help/css/base.css b/help/css/base.css
index 9ecf3d2c..31d9c093 100644
--- a/help/css/base.css
+++ b/help/css/base.css
@@ -24,7 +24,7 @@ body {
/* Backgrounds */
#topic_header {
- background: #fff url(../img/header-bg.png) repeat-x left bottom;
+ background: #fff url(../img/header-bg.png) repeat-x left top;
border-bottom: 1px solid #ccc;
margin-bottom: 15px;
}
@@ -74,11 +74,6 @@ body {
#topic_breadcrumb {
font-size: 11px;
- /*padding: 5px 0 0 0;*/
-}
-
-#topic_content {
-
}
/* Popup */
@@ -98,40 +93,8 @@ body {
padding: 5px 5px 2px 5px;
}
-/* Toc */
-
-#toc_header {
- padding-bottom: 0;
-}
-
-#tabs .ui-tabs-nav {
- border-bottom: 1px solid #ccc;
- padding-top: 19px;
- position: fixed;
- width: 100%;
-}
-
-#tabs .ui-widget-header{
- background: #fff url(../img/header-bg.png) left bottom repeat-x;
-}
-
-#tabs .ui-tabs-panel {
- padding-top: 55px;
- padding-bottom: 20px;
-}
-
-/* Search */
-
-#search_value {
- width: 140px;
-}
-
-#search_results {
- padding-top: 10px;
-}
-
/* Search highlight */
.highlight {
- background-color: yellow
+ background-color: yellow;
}
\ No newline at end of file
diff --git a/help/css/dynatree/chm/0.png b/help/css/dynatree/chm/0.png
new file mode 100644
index 00000000..0189cda7
Binary files /dev/null and b/help/css/dynatree/chm/0.png differ
diff --git a/help/css/dynatree/chm/1.png b/help/css/dynatree/chm/1.png
new file mode 100644
index 00000000..01335b02
Binary files /dev/null and b/help/css/dynatree/chm/1.png differ
diff --git a/help/css/dynatree/chm/10.png b/help/css/dynatree/chm/10.png
new file mode 100644
index 00000000..86c1b70c
Binary files /dev/null and b/help/css/dynatree/chm/10.png differ
diff --git a/help/css/dynatree/chm/11.png b/help/css/dynatree/chm/11.png
new file mode 100644
index 00000000..60da1797
Binary files /dev/null and b/help/css/dynatree/chm/11.png differ
diff --git a/help/css/dynatree/chm/12.png b/help/css/dynatree/chm/12.png
new file mode 100644
index 00000000..7977cad2
Binary files /dev/null and b/help/css/dynatree/chm/12.png differ
diff --git a/help/css/dynatree/chm/13.png b/help/css/dynatree/chm/13.png
new file mode 100644
index 00000000..2d6b99eb
Binary files /dev/null and b/help/css/dynatree/chm/13.png differ
diff --git a/help/css/dynatree/chm/14.png b/help/css/dynatree/chm/14.png
new file mode 100644
index 00000000..c6150b5f
Binary files /dev/null and b/help/css/dynatree/chm/14.png differ
diff --git a/help/css/dynatree/chm/15.png b/help/css/dynatree/chm/15.png
new file mode 100644
index 00000000..58f205ff
Binary files /dev/null and b/help/css/dynatree/chm/15.png differ
diff --git a/help/css/dynatree/chm/16.png b/help/css/dynatree/chm/16.png
new file mode 100644
index 00000000..746f6c4e
Binary files /dev/null and b/help/css/dynatree/chm/16.png differ
diff --git a/help/css/dynatree/chm/17.png b/help/css/dynatree/chm/17.png
new file mode 100644
index 00000000..e450e6b6
Binary files /dev/null and b/help/css/dynatree/chm/17.png differ
diff --git a/help/css/dynatree/chm/18.png b/help/css/dynatree/chm/18.png
new file mode 100644
index 00000000..fae8d066
Binary files /dev/null and b/help/css/dynatree/chm/18.png differ
diff --git a/help/css/dynatree/chm/19.png b/help/css/dynatree/chm/19.png
new file mode 100644
index 00000000..557aa37b
Binary files /dev/null and b/help/css/dynatree/chm/19.png differ
diff --git a/help/css/dynatree/chm/2.png b/help/css/dynatree/chm/2.png
new file mode 100644
index 00000000..38870794
Binary files /dev/null and b/help/css/dynatree/chm/2.png differ
diff --git a/help/css/dynatree/chm/20.png b/help/css/dynatree/chm/20.png
new file mode 100644
index 00000000..cb6845bc
Binary files /dev/null and b/help/css/dynatree/chm/20.png differ
diff --git a/help/css/dynatree/chm/21.png b/help/css/dynatree/chm/21.png
new file mode 100644
index 00000000..bfb11c91
Binary files /dev/null and b/help/css/dynatree/chm/21.png differ
diff --git a/help/css/dynatree/chm/22.png b/help/css/dynatree/chm/22.png
new file mode 100644
index 00000000..17ed9c5b
Binary files /dev/null and b/help/css/dynatree/chm/22.png differ
diff --git a/help/css/dynatree/chm/23.png b/help/css/dynatree/chm/23.png
new file mode 100644
index 00000000..1c4a863b
Binary files /dev/null and b/help/css/dynatree/chm/23.png differ
diff --git a/help/css/dynatree/chm/24.png b/help/css/dynatree/chm/24.png
new file mode 100644
index 00000000..e91b518c
Binary files /dev/null and b/help/css/dynatree/chm/24.png differ
diff --git a/help/css/dynatree/chm/25.png b/help/css/dynatree/chm/25.png
new file mode 100644
index 00000000..00d2d5d3
Binary files /dev/null and b/help/css/dynatree/chm/25.png differ
diff --git a/help/css/dynatree/chm/26.png b/help/css/dynatree/chm/26.png
new file mode 100644
index 00000000..4952af63
Binary files /dev/null and b/help/css/dynatree/chm/26.png differ
diff --git a/help/css/dynatree/chm/27.png b/help/css/dynatree/chm/27.png
new file mode 100644
index 00000000..a61fe9bd
Binary files /dev/null and b/help/css/dynatree/chm/27.png differ
diff --git a/help/css/dynatree/chm/28.png b/help/css/dynatree/chm/28.png
new file mode 100644
index 00000000..52160f07
Binary files /dev/null and b/help/css/dynatree/chm/28.png differ
diff --git a/help/css/dynatree/chm/29.png b/help/css/dynatree/chm/29.png
new file mode 100644
index 00000000..06aa97cb
Binary files /dev/null and b/help/css/dynatree/chm/29.png differ
diff --git a/help/css/dynatree/chm/3.png b/help/css/dynatree/chm/3.png
new file mode 100644
index 00000000..b1c94138
Binary files /dev/null and b/help/css/dynatree/chm/3.png differ
diff --git a/help/css/dynatree/chm/30.png b/help/css/dynatree/chm/30.png
new file mode 100644
index 00000000..7b52276d
Binary files /dev/null and b/help/css/dynatree/chm/30.png differ
diff --git a/help/css/dynatree/chm/31.png b/help/css/dynatree/chm/31.png
new file mode 100644
index 00000000..02283dbb
Binary files /dev/null and b/help/css/dynatree/chm/31.png differ
diff --git a/help/css/dynatree/chm/32.png b/help/css/dynatree/chm/32.png
new file mode 100644
index 00000000..875843c5
Binary files /dev/null and b/help/css/dynatree/chm/32.png differ
diff --git a/help/css/dynatree/chm/33.png b/help/css/dynatree/chm/33.png
new file mode 100644
index 00000000..d64f1371
Binary files /dev/null and b/help/css/dynatree/chm/33.png differ
diff --git a/help/css/dynatree/chm/34.png b/help/css/dynatree/chm/34.png
new file mode 100644
index 00000000..a6d94c5d
Binary files /dev/null and b/help/css/dynatree/chm/34.png differ
diff --git a/help/css/dynatree/chm/35.png b/help/css/dynatree/chm/35.png
new file mode 100644
index 00000000..dfc87bf7
Binary files /dev/null and b/help/css/dynatree/chm/35.png differ
diff --git a/help/css/dynatree/chm/36.png b/help/css/dynatree/chm/36.png
new file mode 100644
index 00000000..ce6235b2
Binary files /dev/null and b/help/css/dynatree/chm/36.png differ
diff --git a/help/css/dynatree/chm/37.png b/help/css/dynatree/chm/37.png
new file mode 100644
index 00000000..01203304
Binary files /dev/null and b/help/css/dynatree/chm/37.png differ
diff --git a/help/css/dynatree/chm/38.png b/help/css/dynatree/chm/38.png
new file mode 100644
index 00000000..5334faee
Binary files /dev/null and b/help/css/dynatree/chm/38.png differ
diff --git a/help/css/dynatree/chm/39.png b/help/css/dynatree/chm/39.png
new file mode 100644
index 00000000..06e446b8
Binary files /dev/null and b/help/css/dynatree/chm/39.png differ
diff --git a/help/css/dynatree/chm/4.png b/help/css/dynatree/chm/4.png
new file mode 100644
index 00000000..6e5cfc09
Binary files /dev/null and b/help/css/dynatree/chm/4.png differ
diff --git a/help/css/dynatree/chm/40.png b/help/css/dynatree/chm/40.png
new file mode 100644
index 00000000..6d744dbe
Binary files /dev/null and b/help/css/dynatree/chm/40.png differ
diff --git a/help/css/dynatree/chm/41.png b/help/css/dynatree/chm/41.png
new file mode 100644
index 00000000..476edf46
Binary files /dev/null and b/help/css/dynatree/chm/41.png differ
diff --git a/help/css/dynatree/chm/5.png b/help/css/dynatree/chm/5.png
new file mode 100644
index 00000000..1df634fe
Binary files /dev/null and b/help/css/dynatree/chm/5.png differ
diff --git a/help/css/dynatree/chm/6.png b/help/css/dynatree/chm/6.png
new file mode 100644
index 00000000..947d9c40
Binary files /dev/null and b/help/css/dynatree/chm/6.png differ
diff --git a/help/css/dynatree/chm/7.png b/help/css/dynatree/chm/7.png
new file mode 100644
index 00000000..a3628866
Binary files /dev/null and b/help/css/dynatree/chm/7.png differ
diff --git a/help/css/dynatree/chm/8.png b/help/css/dynatree/chm/8.png
new file mode 100644
index 00000000..5bcd3eca
Binary files /dev/null and b/help/css/dynatree/chm/8.png differ
diff --git a/help/css/dynatree/chm/9.png b/help/css/dynatree/chm/9.png
new file mode 100644
index 00000000..3b4991d8
Binary files /dev/null and b/help/css/dynatree/chm/9.png differ
diff --git a/help/css/dynatree/chm/icons.gif b/help/css/dynatree/chm/icons.gif
new file mode 100644
index 00000000..c0ccac1b
Binary files /dev/null and b/help/css/dynatree/chm/icons.gif differ
diff --git a/help/css/dynatree/chm/loading.gif b/help/css/dynatree/chm/loading.gif
new file mode 100644
index 00000000..251df054
Binary files /dev/null and b/help/css/dynatree/chm/loading.gif differ
diff --git a/help/css/dynatree/chm/ui.dynatree.css b/help/css/dynatree/chm/ui.dynatree.css
new file mode 100644
index 00000000..8da01f51
--- /dev/null
+++ b/help/css/dynatree/chm/ui.dynatree.css
@@ -0,0 +1,440 @@
+/*******************************************************************************
+ * Tree container
+ */
+ul.dynatree-container
+{
+ font-family: tahoma, arial, helvetica;
+ font-size: 10pt; /* font size should not be too big */
+ white-space: nowrap;
+ padding: 3px;
+ margin: 0; /* issue 201 */
+ background-color: white;
+ border: 1px dotted gray;
+ overflow: auto;
+ height: 100%; /* issue 263 */
+}
+
+ul.dynatree-container ul
+{
+ padding: 0 0 0 16px;
+ margin: 0;
+}
+
+ul.dynatree-container li
+{
+ list-style-image: none;
+ list-style-position: outside;
+ list-style-type: none;
+ -moz-background-clip:border;
+ -moz-background-inline-policy: continuous;
+ -moz-background-origin: padding;
+ background-attachment: scroll;
+ background-color: transparent;
+ background-repeat: repeat-y;
+ background-image: url("vline.gif");
+ background-position: 0 0;
+ /*
+ background-image: url("icons_96x256.gif");
+ background-position: -80px -64px;
+ */
+ margin: 0;
+ padding: 1px 0 0 0;
+}
+/* Suppress lines for last child node */
+ul.dynatree-container li.dynatree-lastsib
+{
+ background-image: none;
+}
+/* Suppress lines if level is fixed expanded (option minExpandLevel) */
+ul.dynatree-no-connector > li
+{
+ background-image: none;
+}
+
+/* Style, when control is disabled */
+.ui-dynatree-disabled ul.dynatree-container
+{
+ opacity: 0.5;
+/* filter: alpha(opacity=50); /* Yields a css warning */
+ background-color: silver;
+}
+
+/*******************************************************************************
+ * Common icon definitions
+ */
+span.dynatree-empty,
+span.dynatree-vline,
+span.dynatree-connector,
+span.dynatree-expander,
+span.dynatree-icon,
+span.dynatree-checkbox,
+span.dynatree-radio,
+span.dynatree-drag-helper-img,
+#dynatree-drop-marker
+{
+ width: 16px;
+ height: 16px;
+/* display: -moz-inline-box; /* @ FF 1+2 removed for issue 221 */
+/* -moz-box-align: start; /* issue 221 */
+ display: inline-block; /* Required to make a span sizeable */
+ vertical-align: top;
+ background-repeat: no-repeat;
+ background-position: left;
+ background-image: url("icons.gif");
+ background-position: 0 0;
+}
+
+/** Used by 'icon' node option: */
+ul.dynatree-container img
+{
+ width: 16px;
+ height: 16px;
+ margin-left: 3px;
+ vertical-align: top;
+ border-style: none;
+}
+
+
+/*******************************************************************************
+ * Lines and connectors
+ */
+
+span.dynatree-connector
+{
+ background-position: -16px -64px;
+}
+
+/*******************************************************************************
+ * Expander icon
+ * Note: IE6 doesn't correctly evaluate multiples class names,
+ * so we create combined class names that can be used in the CSS.
+ *
+ * Prefix: dynatree-exp-
+ * 1st character: 'e': expanded, 'c': collapsed
+ * 2nd character (optional): 'd': lazy (Delayed)
+ * 3rd character (optional): 'l': Last sibling
+ */
+
+span.dynatree-expander
+{
+ background-position: 0px -80px;
+ cursor: pointer;
+}
+.dynatree-exp-cl span.dynatree-expander /* Collapsed, not delayed, last sibling */
+{
+ background-position: 0px -96px;
+}
+.dynatree-exp-cd span.dynatree-expander /* Collapsed, delayed, not last sibling */
+{
+ background-position: -64px -80px;
+}
+.dynatree-exp-cdl span.dynatree-expander /* Collapsed, delayed, last sibling */
+{
+ background-position: -64px -96px;
+}
+.dynatree-exp-e span.dynatree-expander, /* Expanded, not delayed, not last sibling */
+.dynatree-exp-ed span.dynatree-expander /* Expanded, delayed, not last sibling */
+{
+ background-position: -32px -80px;
+}
+.dynatree-exp-el span.dynatree-expander, /* Expanded, not delayed, last sibling */
+.dynatree-exp-edl span.dynatree-expander /* Expanded, delayed, last sibling */
+{
+ background-position: -32px -96px;
+}
+.dynatree-loading span.dynatree-expander /* 'Loading' status overrides all others */
+{
+ background-position: 0 0;
+ background-image: url("loading.gif");
+}
+
+
+/*******************************************************************************
+ * Checkbox icon
+ */
+span.dynatree-checkbox
+{
+ margin-left: 3px;
+ background-position: 0px -32px;
+}
+span.dynatree-checkbox:hover
+{
+ background-position: -16px -32px;
+}
+
+.dynatree-partsel span.dynatree-checkbox
+{
+ background-position: -64px -32px;
+}
+.dynatree-partsel span.dynatree-checkbox:hover
+{
+ background-position: -80px -32px;
+}
+
+.dynatree-selected span.dynatree-checkbox
+{
+ background-position: -32px -32px;
+}
+.dynatree-selected span.dynatree-checkbox:hover
+{
+ background-position: -48px -32px;
+}
+
+/*******************************************************************************
+ * Radiobutton icon
+ * This is a customization, that may be activated by overriding the 'checkbox'
+ * class name as 'dynatree-radio' in the tree options.
+ */
+span.dynatree-radio
+{
+ margin-left: 3px;
+ background-position: 0px -48px;
+}
+span.dynatree-radio:hover
+{
+ background-position: -16px -48px;
+}
+
+.dynatree-partsel span.dynatree-radio
+{
+ background-position: -64px -48px;
+}
+.dynatree-partsel span.dynatree-radio:hover
+{
+ background-position: -80px -48px;
+}
+
+.dynatree-selected span.dynatree-radio
+{
+ background-position: -32px -48px;
+}
+.dynatree-selected span.dynatree-radio:hover
+{
+ background-position: -48px -48px;
+}
+
+/*******************************************************************************
+ * Node type icon
+ * Note: IE6 doesn't correctly evaluate multiples class names,
+ * so we create combined class names that can be used in the CSS.
+ *
+ * Prefix: dynatree-ico-
+ * 1st character: 'e': expanded, 'c': collapsed
+ * 2nd character (optional): 'f': folder
+ */
+
+span.dynatree-icon /* Default icon */
+{
+ margin-left: 3px;
+ background-position: 0px 0px;
+}
+
+.dynatree-ico-cf span.dynatree-icon /* Collapsed Folder */
+{
+ background-position: 0px -16px;
+}
+
+.dynatree-ico-ef span.dynatree-icon /* Expanded Folder */
+{
+ background-position: -64px -16px;
+}
+
+/* Status node icons */
+
+.dynatree-statusnode-wait span.dynatree-icon
+{
+ background-image: url("loading.gif");
+}
+
+.dynatree-statusnode-error span.dynatree-icon
+{
+ background-position: 0px -112px;
+/* background-image: url("ltError.gif");*/
+}
+
+/*******************************************************************************
+ * Node titles
+ */
+
+/* @Chrome: otherwise hit area of node titles is broken (issue 133)
+ Removed again for issue 165; (133 couldn't be reproduced) */
+span.dynatree-node
+{
+/* display: -moz-inline-box; /* issue 133, 165, 172, 192. removed for issue 221*/
+/* -moz-box-align: start; /* issue 221 */
+/* display: inline-block; /* Required to make a span sizeable */
+}
+
+
+/* Remove blue color and underline from title links */
+ul.dynatree-container a
+/*, ul.dynatree-container a:visited*/
+{
+ color: black; /* inherit doesn't work on IE */
+ text-decoration: none;
+ vertical-align: top;
+ margin: 0px;
+ margin-left: 3px;
+/* outline: 0; /* @ Firefox, prevent dotted border after click */
+}
+
+ul.dynatree-container a:hover
+{
+/* text-decoration: underline; */
+ background-color: #F2F7FD; /* light blue */
+ border-color: #B8D6FB; /* darker light blue */
+}
+
+span.dynatree-node a
+{
+ font-size: 10pt; /* required for IE, quirks mode */
+ display: inline-block; /* Better alignment, when title contains */
+/* vertical-align: top;*/
+ padding-left: 3px;
+ padding-right: 3px; /* Otherwise italic font will be outside bounds */
+ /* line-height: 16px; /* should be the same as img height, in case 16 px */
+}
+span.dynatree-folder a
+{
+ font-weight: bold;
+}
+
+ul.dynatree-container a:focus,
+span.dynatree-focused a:link /* @IE */
+{
+ background-color: #EFEBDE; /* gray */
+}
+
+span.dynatree-has-children a
+{
+}
+
+span.dynatree-expanded a
+{
+}
+
+span.dynatree-selected a
+{
+ color: green;
+ font-style: italic;
+}
+
+span.dynatree-active a
+{
+ background-color: #3169C6 !important;
+ color: white !important; /* @ IE6 */
+}
+
+/*******************************************************************************
+ * Drag'n'drop support
+ */
+
+/*** Helper object ************************************************************/
+div.dynatree-drag-helper
+{
+}
+div.dynatree-drag-helper a
+{
+ border: 1px solid gray;
+ background-color: white;
+ padding-left: 5px;
+ padding-right: 5px;
+ opacity: 0.8;
+}
+span.dynatree-drag-helper-img
+{
+ /*
+ position: relative;
+ left: -16px;
+ */
+}
+div.dynatree-drag-helper /*.dynatree-drop-accept*/
+{
+
+/* border-color: green;
+ background-color: red;*/
+}
+div.dynatree-drop-accept span.dynatree-drag-helper-img
+{
+ background-position: -32px -112px;
+}
+div.dynatree-drag-helper.dynatree-drop-reject
+{
+ border-color: red;
+}
+div.dynatree-drop-reject span.dynatree-drag-helper-img
+{
+ background-position: -16px -112px;
+}
+
+/*** Drop marker icon *********************************************************/
+
+#dynatree-drop-marker
+{
+ width: 24px;
+ position: absolute;
+ background-position: 0 -128px;
+ margin: 0;
+/* border: 1px solid red; */
+}
+#dynatree-drop-marker.dynatree-drop-after,
+#dynatree-drop-marker.dynatree-drop-before
+{
+ width:64px;
+ background-position: 0 -144px;
+}
+#dynatree-drop-marker.dynatree-drop-copy
+{
+ background-position: -64px -128px;
+}
+#dynatree-drop-marker.dynatree-drop-move
+{
+ background-position: -64px -128px;
+}
+
+/*** Source node while dragging ***********************************************/
+
+span.dynatree-drag-source
+{
+ /* border: 1px dotted gray; */
+ background-color: #e0e0e0;
+}
+span.dynatree-drag-source a
+{
+ color: gray;
+}
+
+/*** Target node while dragging cursor is over it *****************************/
+
+span.dynatree-drop-target
+{
+ /*border: 1px solid gray;*/
+}
+span.dynatree-drop-target a
+{
+}
+span.dynatree-drop-target.dynatree-drop-accept a
+{
+ /*border: 1px solid green;*/
+ background-color: #3169C6 !important;
+ color: white !important; /* @ IE6 */
+ text-decoration: none;
+}
+span.dynatree-drop-target.dynatree-drop-reject
+{
+ /*border: 1px solid red;*/
+}
+span.dynatree-drop-target.dynatree-drop-after a
+{
+}
+
+
+/*******************************************************************************
+ * Custom node classes (sample)
+ */
+
+span.custom1 a
+{
+ background-color: maroon;
+ color: yellow;
+}
diff --git a/help/css/dynatree/chm/vline.gif b/help/css/dynatree/chm/vline.gif
new file mode 100644
index 00000000..1b00ae50
Binary files /dev/null and b/help/css/dynatree/chm/vline.gif differ
diff --git a/help/css/dynatree/folder/0.png b/help/css/dynatree/folder/0.png
new file mode 100644
index 00000000..0189cda7
Binary files /dev/null and b/help/css/dynatree/folder/0.png differ
diff --git a/help/css/dynatree/folder/1.png b/help/css/dynatree/folder/1.png
new file mode 100644
index 00000000..01335b02
Binary files /dev/null and b/help/css/dynatree/folder/1.png differ
diff --git a/help/css/dynatree/folder/10.png b/help/css/dynatree/folder/10.png
new file mode 100644
index 00000000..86c1b70c
Binary files /dev/null and b/help/css/dynatree/folder/10.png differ
diff --git a/help/css/dynatree/folder/11.png b/help/css/dynatree/folder/11.png
new file mode 100644
index 00000000..60da1797
Binary files /dev/null and b/help/css/dynatree/folder/11.png differ
diff --git a/help/css/dynatree/folder/12.png b/help/css/dynatree/folder/12.png
new file mode 100644
index 00000000..7977cad2
Binary files /dev/null and b/help/css/dynatree/folder/12.png differ
diff --git a/help/css/dynatree/folder/13.png b/help/css/dynatree/folder/13.png
new file mode 100644
index 00000000..2d6b99eb
Binary files /dev/null and b/help/css/dynatree/folder/13.png differ
diff --git a/help/css/dynatree/folder/14.png b/help/css/dynatree/folder/14.png
new file mode 100644
index 00000000..c6150b5f
Binary files /dev/null and b/help/css/dynatree/folder/14.png differ
diff --git a/help/css/dynatree/folder/15.png b/help/css/dynatree/folder/15.png
new file mode 100644
index 00000000..58f205ff
Binary files /dev/null and b/help/css/dynatree/folder/15.png differ
diff --git a/help/css/dynatree/folder/16.png b/help/css/dynatree/folder/16.png
new file mode 100644
index 00000000..746f6c4e
Binary files /dev/null and b/help/css/dynatree/folder/16.png differ
diff --git a/help/css/dynatree/folder/17.png b/help/css/dynatree/folder/17.png
new file mode 100644
index 00000000..e450e6b6
Binary files /dev/null and b/help/css/dynatree/folder/17.png differ
diff --git a/help/css/dynatree/folder/18.png b/help/css/dynatree/folder/18.png
new file mode 100644
index 00000000..fae8d066
Binary files /dev/null and b/help/css/dynatree/folder/18.png differ
diff --git a/help/css/dynatree/folder/19.png b/help/css/dynatree/folder/19.png
new file mode 100644
index 00000000..557aa37b
Binary files /dev/null and b/help/css/dynatree/folder/19.png differ
diff --git a/help/css/dynatree/folder/2.png b/help/css/dynatree/folder/2.png
new file mode 100644
index 00000000..38870794
Binary files /dev/null and b/help/css/dynatree/folder/2.png differ
diff --git a/help/css/dynatree/folder/20.png b/help/css/dynatree/folder/20.png
new file mode 100644
index 00000000..cb6845bc
Binary files /dev/null and b/help/css/dynatree/folder/20.png differ
diff --git a/help/css/dynatree/folder/21.png b/help/css/dynatree/folder/21.png
new file mode 100644
index 00000000..bfb11c91
Binary files /dev/null and b/help/css/dynatree/folder/21.png differ
diff --git a/help/css/dynatree/folder/22.png b/help/css/dynatree/folder/22.png
new file mode 100644
index 00000000..17ed9c5b
Binary files /dev/null and b/help/css/dynatree/folder/22.png differ
diff --git a/help/css/dynatree/folder/23.png b/help/css/dynatree/folder/23.png
new file mode 100644
index 00000000..1c4a863b
Binary files /dev/null and b/help/css/dynatree/folder/23.png differ
diff --git a/help/css/dynatree/folder/24.png b/help/css/dynatree/folder/24.png
new file mode 100644
index 00000000..e91b518c
Binary files /dev/null and b/help/css/dynatree/folder/24.png differ
diff --git a/help/css/dynatree/folder/25.png b/help/css/dynatree/folder/25.png
new file mode 100644
index 00000000..00d2d5d3
Binary files /dev/null and b/help/css/dynatree/folder/25.png differ
diff --git a/help/css/dynatree/folder/26.png b/help/css/dynatree/folder/26.png
new file mode 100644
index 00000000..4952af63
Binary files /dev/null and b/help/css/dynatree/folder/26.png differ
diff --git a/help/css/dynatree/folder/27.png b/help/css/dynatree/folder/27.png
new file mode 100644
index 00000000..a61fe9bd
Binary files /dev/null and b/help/css/dynatree/folder/27.png differ
diff --git a/help/css/dynatree/folder/28.png b/help/css/dynatree/folder/28.png
new file mode 100644
index 00000000..52160f07
Binary files /dev/null and b/help/css/dynatree/folder/28.png differ
diff --git a/help/css/dynatree/folder/29.png b/help/css/dynatree/folder/29.png
new file mode 100644
index 00000000..06aa97cb
Binary files /dev/null and b/help/css/dynatree/folder/29.png differ
diff --git a/help/css/dynatree/folder/3.png b/help/css/dynatree/folder/3.png
new file mode 100644
index 00000000..b1c94138
Binary files /dev/null and b/help/css/dynatree/folder/3.png differ
diff --git a/help/css/dynatree/folder/30.png b/help/css/dynatree/folder/30.png
new file mode 100644
index 00000000..7b52276d
Binary files /dev/null and b/help/css/dynatree/folder/30.png differ
diff --git a/help/css/dynatree/folder/31.png b/help/css/dynatree/folder/31.png
new file mode 100644
index 00000000..02283dbb
Binary files /dev/null and b/help/css/dynatree/folder/31.png differ
diff --git a/help/css/dynatree/folder/32.png b/help/css/dynatree/folder/32.png
new file mode 100644
index 00000000..875843c5
Binary files /dev/null and b/help/css/dynatree/folder/32.png differ
diff --git a/help/css/dynatree/folder/33.png b/help/css/dynatree/folder/33.png
new file mode 100644
index 00000000..d64f1371
Binary files /dev/null and b/help/css/dynatree/folder/33.png differ
diff --git a/help/css/dynatree/folder/34.png b/help/css/dynatree/folder/34.png
new file mode 100644
index 00000000..a6d94c5d
Binary files /dev/null and b/help/css/dynatree/folder/34.png differ
diff --git a/help/css/dynatree/folder/35.png b/help/css/dynatree/folder/35.png
new file mode 100644
index 00000000..dfc87bf7
Binary files /dev/null and b/help/css/dynatree/folder/35.png differ
diff --git a/help/css/dynatree/folder/36.png b/help/css/dynatree/folder/36.png
new file mode 100644
index 00000000..ce6235b2
Binary files /dev/null and b/help/css/dynatree/folder/36.png differ
diff --git a/help/css/dynatree/folder/37.png b/help/css/dynatree/folder/37.png
new file mode 100644
index 00000000..01203304
Binary files /dev/null and b/help/css/dynatree/folder/37.png differ
diff --git a/help/css/dynatree/folder/38.png b/help/css/dynatree/folder/38.png
new file mode 100644
index 00000000..5334faee
Binary files /dev/null and b/help/css/dynatree/folder/38.png differ
diff --git a/help/css/dynatree/folder/39.png b/help/css/dynatree/folder/39.png
new file mode 100644
index 00000000..06e446b8
Binary files /dev/null and b/help/css/dynatree/folder/39.png differ
diff --git a/help/css/dynatree/folder/4.png b/help/css/dynatree/folder/4.png
new file mode 100644
index 00000000..6e5cfc09
Binary files /dev/null and b/help/css/dynatree/folder/4.png differ
diff --git a/help/css/dynatree/folder/40.png b/help/css/dynatree/folder/40.png
new file mode 100644
index 00000000..6d744dbe
Binary files /dev/null and b/help/css/dynatree/folder/40.png differ
diff --git a/help/css/dynatree/folder/41.png b/help/css/dynatree/folder/41.png
new file mode 100644
index 00000000..476edf46
Binary files /dev/null and b/help/css/dynatree/folder/41.png differ
diff --git a/help/css/dynatree/folder/5.png b/help/css/dynatree/folder/5.png
new file mode 100644
index 00000000..1df634fe
Binary files /dev/null and b/help/css/dynatree/folder/5.png differ
diff --git a/help/css/dynatree/folder/6.png b/help/css/dynatree/folder/6.png
new file mode 100644
index 00000000..947d9c40
Binary files /dev/null and b/help/css/dynatree/folder/6.png differ
diff --git a/help/css/dynatree/folder/7.png b/help/css/dynatree/folder/7.png
new file mode 100644
index 00000000..a3628866
Binary files /dev/null and b/help/css/dynatree/folder/7.png differ
diff --git a/help/css/dynatree/folder/8.png b/help/css/dynatree/folder/8.png
new file mode 100644
index 00000000..5bcd3eca
Binary files /dev/null and b/help/css/dynatree/folder/8.png differ
diff --git a/help/css/dynatree/folder/9.png b/help/css/dynatree/folder/9.png
new file mode 100644
index 00000000..3b4991d8
Binary files /dev/null and b/help/css/dynatree/folder/9.png differ
diff --git a/help/css/dynatree/folder/icons.gif b/help/css/dynatree/folder/icons.gif
new file mode 100644
index 00000000..a58eb93f
Binary files /dev/null and b/help/css/dynatree/folder/icons.gif differ
diff --git a/help/css/dynatree/folder/loading.gif b/help/css/dynatree/folder/loading.gif
new file mode 100644
index 00000000..251df054
Binary files /dev/null and b/help/css/dynatree/folder/loading.gif differ
diff --git a/help/css/dynatree/folder/ui.dynatree.css b/help/css/dynatree/folder/ui.dynatree.css
new file mode 100644
index 00000000..8da01f51
--- /dev/null
+++ b/help/css/dynatree/folder/ui.dynatree.css
@@ -0,0 +1,440 @@
+/*******************************************************************************
+ * Tree container
+ */
+ul.dynatree-container
+{
+ font-family: tahoma, arial, helvetica;
+ font-size: 10pt; /* font size should not be too big */
+ white-space: nowrap;
+ padding: 3px;
+ margin: 0; /* issue 201 */
+ background-color: white;
+ border: 1px dotted gray;
+ overflow: auto;
+ height: 100%; /* issue 263 */
+}
+
+ul.dynatree-container ul
+{
+ padding: 0 0 0 16px;
+ margin: 0;
+}
+
+ul.dynatree-container li
+{
+ list-style-image: none;
+ list-style-position: outside;
+ list-style-type: none;
+ -moz-background-clip:border;
+ -moz-background-inline-policy: continuous;
+ -moz-background-origin: padding;
+ background-attachment: scroll;
+ background-color: transparent;
+ background-repeat: repeat-y;
+ background-image: url("vline.gif");
+ background-position: 0 0;
+ /*
+ background-image: url("icons_96x256.gif");
+ background-position: -80px -64px;
+ */
+ margin: 0;
+ padding: 1px 0 0 0;
+}
+/* Suppress lines for last child node */
+ul.dynatree-container li.dynatree-lastsib
+{
+ background-image: none;
+}
+/* Suppress lines if level is fixed expanded (option minExpandLevel) */
+ul.dynatree-no-connector > li
+{
+ background-image: none;
+}
+
+/* Style, when control is disabled */
+.ui-dynatree-disabled ul.dynatree-container
+{
+ opacity: 0.5;
+/* filter: alpha(opacity=50); /* Yields a css warning */
+ background-color: silver;
+}
+
+/*******************************************************************************
+ * Common icon definitions
+ */
+span.dynatree-empty,
+span.dynatree-vline,
+span.dynatree-connector,
+span.dynatree-expander,
+span.dynatree-icon,
+span.dynatree-checkbox,
+span.dynatree-radio,
+span.dynatree-drag-helper-img,
+#dynatree-drop-marker
+{
+ width: 16px;
+ height: 16px;
+/* display: -moz-inline-box; /* @ FF 1+2 removed for issue 221 */
+/* -moz-box-align: start; /* issue 221 */
+ display: inline-block; /* Required to make a span sizeable */
+ vertical-align: top;
+ background-repeat: no-repeat;
+ background-position: left;
+ background-image: url("icons.gif");
+ background-position: 0 0;
+}
+
+/** Used by 'icon' node option: */
+ul.dynatree-container img
+{
+ width: 16px;
+ height: 16px;
+ margin-left: 3px;
+ vertical-align: top;
+ border-style: none;
+}
+
+
+/*******************************************************************************
+ * Lines and connectors
+ */
+
+span.dynatree-connector
+{
+ background-position: -16px -64px;
+}
+
+/*******************************************************************************
+ * Expander icon
+ * Note: IE6 doesn't correctly evaluate multiples class names,
+ * so we create combined class names that can be used in the CSS.
+ *
+ * Prefix: dynatree-exp-
+ * 1st character: 'e': expanded, 'c': collapsed
+ * 2nd character (optional): 'd': lazy (Delayed)
+ * 3rd character (optional): 'l': Last sibling
+ */
+
+span.dynatree-expander
+{
+ background-position: 0px -80px;
+ cursor: pointer;
+}
+.dynatree-exp-cl span.dynatree-expander /* Collapsed, not delayed, last sibling */
+{
+ background-position: 0px -96px;
+}
+.dynatree-exp-cd span.dynatree-expander /* Collapsed, delayed, not last sibling */
+{
+ background-position: -64px -80px;
+}
+.dynatree-exp-cdl span.dynatree-expander /* Collapsed, delayed, last sibling */
+{
+ background-position: -64px -96px;
+}
+.dynatree-exp-e span.dynatree-expander, /* Expanded, not delayed, not last sibling */
+.dynatree-exp-ed span.dynatree-expander /* Expanded, delayed, not last sibling */
+{
+ background-position: -32px -80px;
+}
+.dynatree-exp-el span.dynatree-expander, /* Expanded, not delayed, last sibling */
+.dynatree-exp-edl span.dynatree-expander /* Expanded, delayed, last sibling */
+{
+ background-position: -32px -96px;
+}
+.dynatree-loading span.dynatree-expander /* 'Loading' status overrides all others */
+{
+ background-position: 0 0;
+ background-image: url("loading.gif");
+}
+
+
+/*******************************************************************************
+ * Checkbox icon
+ */
+span.dynatree-checkbox
+{
+ margin-left: 3px;
+ background-position: 0px -32px;
+}
+span.dynatree-checkbox:hover
+{
+ background-position: -16px -32px;
+}
+
+.dynatree-partsel span.dynatree-checkbox
+{
+ background-position: -64px -32px;
+}
+.dynatree-partsel span.dynatree-checkbox:hover
+{
+ background-position: -80px -32px;
+}
+
+.dynatree-selected span.dynatree-checkbox
+{
+ background-position: -32px -32px;
+}
+.dynatree-selected span.dynatree-checkbox:hover
+{
+ background-position: -48px -32px;
+}
+
+/*******************************************************************************
+ * Radiobutton icon
+ * This is a customization, that may be activated by overriding the 'checkbox'
+ * class name as 'dynatree-radio' in the tree options.
+ */
+span.dynatree-radio
+{
+ margin-left: 3px;
+ background-position: 0px -48px;
+}
+span.dynatree-radio:hover
+{
+ background-position: -16px -48px;
+}
+
+.dynatree-partsel span.dynatree-radio
+{
+ background-position: -64px -48px;
+}
+.dynatree-partsel span.dynatree-radio:hover
+{
+ background-position: -80px -48px;
+}
+
+.dynatree-selected span.dynatree-radio
+{
+ background-position: -32px -48px;
+}
+.dynatree-selected span.dynatree-radio:hover
+{
+ background-position: -48px -48px;
+}
+
+/*******************************************************************************
+ * Node type icon
+ * Note: IE6 doesn't correctly evaluate multiples class names,
+ * so we create combined class names that can be used in the CSS.
+ *
+ * Prefix: dynatree-ico-
+ * 1st character: 'e': expanded, 'c': collapsed
+ * 2nd character (optional): 'f': folder
+ */
+
+span.dynatree-icon /* Default icon */
+{
+ margin-left: 3px;
+ background-position: 0px 0px;
+}
+
+.dynatree-ico-cf span.dynatree-icon /* Collapsed Folder */
+{
+ background-position: 0px -16px;
+}
+
+.dynatree-ico-ef span.dynatree-icon /* Expanded Folder */
+{
+ background-position: -64px -16px;
+}
+
+/* Status node icons */
+
+.dynatree-statusnode-wait span.dynatree-icon
+{
+ background-image: url("loading.gif");
+}
+
+.dynatree-statusnode-error span.dynatree-icon
+{
+ background-position: 0px -112px;
+/* background-image: url("ltError.gif");*/
+}
+
+/*******************************************************************************
+ * Node titles
+ */
+
+/* @Chrome: otherwise hit area of node titles is broken (issue 133)
+ Removed again for issue 165; (133 couldn't be reproduced) */
+span.dynatree-node
+{
+/* display: -moz-inline-box; /* issue 133, 165, 172, 192. removed for issue 221*/
+/* -moz-box-align: start; /* issue 221 */
+/* display: inline-block; /* Required to make a span sizeable */
+}
+
+
+/* Remove blue color and underline from title links */
+ul.dynatree-container a
+/*, ul.dynatree-container a:visited*/
+{
+ color: black; /* inherit doesn't work on IE */
+ text-decoration: none;
+ vertical-align: top;
+ margin: 0px;
+ margin-left: 3px;
+/* outline: 0; /* @ Firefox, prevent dotted border after click */
+}
+
+ul.dynatree-container a:hover
+{
+/* text-decoration: underline; */
+ background-color: #F2F7FD; /* light blue */
+ border-color: #B8D6FB; /* darker light blue */
+}
+
+span.dynatree-node a
+{
+ font-size: 10pt; /* required for IE, quirks mode */
+ display: inline-block; /* Better alignment, when title contains */
+/* vertical-align: top;*/
+ padding-left: 3px;
+ padding-right: 3px; /* Otherwise italic font will be outside bounds */
+ /* line-height: 16px; /* should be the same as img height, in case 16 px */
+}
+span.dynatree-folder a
+{
+ font-weight: bold;
+}
+
+ul.dynatree-container a:focus,
+span.dynatree-focused a:link /* @IE */
+{
+ background-color: #EFEBDE; /* gray */
+}
+
+span.dynatree-has-children a
+{
+}
+
+span.dynatree-expanded a
+{
+}
+
+span.dynatree-selected a
+{
+ color: green;
+ font-style: italic;
+}
+
+span.dynatree-active a
+{
+ background-color: #3169C6 !important;
+ color: white !important; /* @ IE6 */
+}
+
+/*******************************************************************************
+ * Drag'n'drop support
+ */
+
+/*** Helper object ************************************************************/
+div.dynatree-drag-helper
+{
+}
+div.dynatree-drag-helper a
+{
+ border: 1px solid gray;
+ background-color: white;
+ padding-left: 5px;
+ padding-right: 5px;
+ opacity: 0.8;
+}
+span.dynatree-drag-helper-img
+{
+ /*
+ position: relative;
+ left: -16px;
+ */
+}
+div.dynatree-drag-helper /*.dynatree-drop-accept*/
+{
+
+/* border-color: green;
+ background-color: red;*/
+}
+div.dynatree-drop-accept span.dynatree-drag-helper-img
+{
+ background-position: -32px -112px;
+}
+div.dynatree-drag-helper.dynatree-drop-reject
+{
+ border-color: red;
+}
+div.dynatree-drop-reject span.dynatree-drag-helper-img
+{
+ background-position: -16px -112px;
+}
+
+/*** Drop marker icon *********************************************************/
+
+#dynatree-drop-marker
+{
+ width: 24px;
+ position: absolute;
+ background-position: 0 -128px;
+ margin: 0;
+/* border: 1px solid red; */
+}
+#dynatree-drop-marker.dynatree-drop-after,
+#dynatree-drop-marker.dynatree-drop-before
+{
+ width:64px;
+ background-position: 0 -144px;
+}
+#dynatree-drop-marker.dynatree-drop-copy
+{
+ background-position: -64px -128px;
+}
+#dynatree-drop-marker.dynatree-drop-move
+{
+ background-position: -64px -128px;
+}
+
+/*** Source node while dragging ***********************************************/
+
+span.dynatree-drag-source
+{
+ /* border: 1px dotted gray; */
+ background-color: #e0e0e0;
+}
+span.dynatree-drag-source a
+{
+ color: gray;
+}
+
+/*** Target node while dragging cursor is over it *****************************/
+
+span.dynatree-drop-target
+{
+ /*border: 1px solid gray;*/
+}
+span.dynatree-drop-target a
+{
+}
+span.dynatree-drop-target.dynatree-drop-accept a
+{
+ /*border: 1px solid green;*/
+ background-color: #3169C6 !important;
+ color: white !important; /* @ IE6 */
+ text-decoration: none;
+}
+span.dynatree-drop-target.dynatree-drop-reject
+{
+ /*border: 1px solid red;*/
+}
+span.dynatree-drop-target.dynatree-drop-after a
+{
+}
+
+
+/*******************************************************************************
+ * Custom node classes (sample)
+ */
+
+span.custom1 a
+{
+ background-color: maroon;
+ color: yellow;
+}
diff --git a/help/css/dynatree/folder/vline.gif b/help/css/dynatree/folder/vline.gif
new file mode 100644
index 00000000..1b00ae50
Binary files /dev/null and b/help/css/dynatree/folder/vline.gif differ
diff --git a/help/css/dynatree/vista/0.png b/help/css/dynatree/vista/0.png
new file mode 100644
index 00000000..0189cda7
Binary files /dev/null and b/help/css/dynatree/vista/0.png differ
diff --git a/help/css/dynatree/vista/1.png b/help/css/dynatree/vista/1.png
new file mode 100644
index 00000000..01335b02
Binary files /dev/null and b/help/css/dynatree/vista/1.png differ
diff --git a/help/css/dynatree/vista/10.png b/help/css/dynatree/vista/10.png
new file mode 100644
index 00000000..86c1b70c
Binary files /dev/null and b/help/css/dynatree/vista/10.png differ
diff --git a/help/css/dynatree/vista/11.png b/help/css/dynatree/vista/11.png
new file mode 100644
index 00000000..60da1797
Binary files /dev/null and b/help/css/dynatree/vista/11.png differ
diff --git a/help/css/dynatree/vista/12.png b/help/css/dynatree/vista/12.png
new file mode 100644
index 00000000..7977cad2
Binary files /dev/null and b/help/css/dynatree/vista/12.png differ
diff --git a/help/css/dynatree/vista/13.png b/help/css/dynatree/vista/13.png
new file mode 100644
index 00000000..2d6b99eb
Binary files /dev/null and b/help/css/dynatree/vista/13.png differ
diff --git a/help/css/dynatree/vista/14.png b/help/css/dynatree/vista/14.png
new file mode 100644
index 00000000..c6150b5f
Binary files /dev/null and b/help/css/dynatree/vista/14.png differ
diff --git a/help/css/dynatree/vista/15.png b/help/css/dynatree/vista/15.png
new file mode 100644
index 00000000..58f205ff
Binary files /dev/null and b/help/css/dynatree/vista/15.png differ
diff --git a/help/css/dynatree/vista/16.png b/help/css/dynatree/vista/16.png
new file mode 100644
index 00000000..746f6c4e
Binary files /dev/null and b/help/css/dynatree/vista/16.png differ
diff --git a/help/css/dynatree/vista/17.png b/help/css/dynatree/vista/17.png
new file mode 100644
index 00000000..e450e6b6
Binary files /dev/null and b/help/css/dynatree/vista/17.png differ
diff --git a/help/css/dynatree/vista/18.png b/help/css/dynatree/vista/18.png
new file mode 100644
index 00000000..fae8d066
Binary files /dev/null and b/help/css/dynatree/vista/18.png differ
diff --git a/help/css/dynatree/vista/19.png b/help/css/dynatree/vista/19.png
new file mode 100644
index 00000000..557aa37b
Binary files /dev/null and b/help/css/dynatree/vista/19.png differ
diff --git a/help/css/dynatree/vista/2.png b/help/css/dynatree/vista/2.png
new file mode 100644
index 00000000..38870794
Binary files /dev/null and b/help/css/dynatree/vista/2.png differ
diff --git a/help/css/dynatree/vista/20.png b/help/css/dynatree/vista/20.png
new file mode 100644
index 00000000..cb6845bc
Binary files /dev/null and b/help/css/dynatree/vista/20.png differ
diff --git a/help/css/dynatree/vista/21.png b/help/css/dynatree/vista/21.png
new file mode 100644
index 00000000..bfb11c91
Binary files /dev/null and b/help/css/dynatree/vista/21.png differ
diff --git a/help/css/dynatree/vista/22.png b/help/css/dynatree/vista/22.png
new file mode 100644
index 00000000..17ed9c5b
Binary files /dev/null and b/help/css/dynatree/vista/22.png differ
diff --git a/help/css/dynatree/vista/23.png b/help/css/dynatree/vista/23.png
new file mode 100644
index 00000000..1c4a863b
Binary files /dev/null and b/help/css/dynatree/vista/23.png differ
diff --git a/help/css/dynatree/vista/24.png b/help/css/dynatree/vista/24.png
new file mode 100644
index 00000000..e91b518c
Binary files /dev/null and b/help/css/dynatree/vista/24.png differ
diff --git a/help/css/dynatree/vista/25.png b/help/css/dynatree/vista/25.png
new file mode 100644
index 00000000..00d2d5d3
Binary files /dev/null and b/help/css/dynatree/vista/25.png differ
diff --git a/help/css/dynatree/vista/26.png b/help/css/dynatree/vista/26.png
new file mode 100644
index 00000000..4952af63
Binary files /dev/null and b/help/css/dynatree/vista/26.png differ
diff --git a/help/css/dynatree/vista/27.png b/help/css/dynatree/vista/27.png
new file mode 100644
index 00000000..a61fe9bd
Binary files /dev/null and b/help/css/dynatree/vista/27.png differ
diff --git a/help/css/dynatree/vista/28.png b/help/css/dynatree/vista/28.png
new file mode 100644
index 00000000..52160f07
Binary files /dev/null and b/help/css/dynatree/vista/28.png differ
diff --git a/help/css/dynatree/vista/29.png b/help/css/dynatree/vista/29.png
new file mode 100644
index 00000000..06aa97cb
Binary files /dev/null and b/help/css/dynatree/vista/29.png differ
diff --git a/help/css/dynatree/vista/3.png b/help/css/dynatree/vista/3.png
new file mode 100644
index 00000000..b1c94138
Binary files /dev/null and b/help/css/dynatree/vista/3.png differ
diff --git a/help/css/dynatree/vista/30.png b/help/css/dynatree/vista/30.png
new file mode 100644
index 00000000..7b52276d
Binary files /dev/null and b/help/css/dynatree/vista/30.png differ
diff --git a/help/css/dynatree/vista/31.png b/help/css/dynatree/vista/31.png
new file mode 100644
index 00000000..02283dbb
Binary files /dev/null and b/help/css/dynatree/vista/31.png differ
diff --git a/help/css/dynatree/vista/32.png b/help/css/dynatree/vista/32.png
new file mode 100644
index 00000000..875843c5
Binary files /dev/null and b/help/css/dynatree/vista/32.png differ
diff --git a/help/css/dynatree/vista/33.png b/help/css/dynatree/vista/33.png
new file mode 100644
index 00000000..d64f1371
Binary files /dev/null and b/help/css/dynatree/vista/33.png differ
diff --git a/help/css/dynatree/vista/34.png b/help/css/dynatree/vista/34.png
new file mode 100644
index 00000000..a6d94c5d
Binary files /dev/null and b/help/css/dynatree/vista/34.png differ
diff --git a/help/css/dynatree/vista/35.png b/help/css/dynatree/vista/35.png
new file mode 100644
index 00000000..dfc87bf7
Binary files /dev/null and b/help/css/dynatree/vista/35.png differ
diff --git a/help/css/dynatree/vista/36.png b/help/css/dynatree/vista/36.png
new file mode 100644
index 00000000..ce6235b2
Binary files /dev/null and b/help/css/dynatree/vista/36.png differ
diff --git a/help/css/dynatree/vista/37.png b/help/css/dynatree/vista/37.png
new file mode 100644
index 00000000..01203304
Binary files /dev/null and b/help/css/dynatree/vista/37.png differ
diff --git a/help/css/dynatree/vista/38.png b/help/css/dynatree/vista/38.png
new file mode 100644
index 00000000..5334faee
Binary files /dev/null and b/help/css/dynatree/vista/38.png differ
diff --git a/help/css/dynatree/vista/39.png b/help/css/dynatree/vista/39.png
new file mode 100644
index 00000000..06e446b8
Binary files /dev/null and b/help/css/dynatree/vista/39.png differ
diff --git a/help/css/dynatree/vista/4.png b/help/css/dynatree/vista/4.png
new file mode 100644
index 00000000..6e5cfc09
Binary files /dev/null and b/help/css/dynatree/vista/4.png differ
diff --git a/help/css/dynatree/vista/40.png b/help/css/dynatree/vista/40.png
new file mode 100644
index 00000000..6d744dbe
Binary files /dev/null and b/help/css/dynatree/vista/40.png differ
diff --git a/help/css/dynatree/vista/41.png b/help/css/dynatree/vista/41.png
new file mode 100644
index 00000000..476edf46
Binary files /dev/null and b/help/css/dynatree/vista/41.png differ
diff --git a/help/css/dynatree/vista/5.png b/help/css/dynatree/vista/5.png
new file mode 100644
index 00000000..1df634fe
Binary files /dev/null and b/help/css/dynatree/vista/5.png differ
diff --git a/help/css/dynatree/vista/6.png b/help/css/dynatree/vista/6.png
new file mode 100644
index 00000000..947d9c40
Binary files /dev/null and b/help/css/dynatree/vista/6.png differ
diff --git a/help/css/dynatree/vista/7.png b/help/css/dynatree/vista/7.png
new file mode 100644
index 00000000..a3628866
Binary files /dev/null and b/help/css/dynatree/vista/7.png differ
diff --git a/help/css/dynatree/vista/8.png b/help/css/dynatree/vista/8.png
new file mode 100644
index 00000000..5bcd3eca
Binary files /dev/null and b/help/css/dynatree/vista/8.png differ
diff --git a/help/css/dynatree/vista/9.png b/help/css/dynatree/vista/9.png
new file mode 100644
index 00000000..3b4991d8
Binary files /dev/null and b/help/css/dynatree/vista/9.png differ
diff --git a/help/css/dynatree/vista/icons.gif b/help/css/dynatree/vista/icons.gif
new file mode 100644
index 00000000..6e237a0f
Binary files /dev/null and b/help/css/dynatree/vista/icons.gif differ
diff --git a/help/css/dynatree/vista/loading.gif b/help/css/dynatree/vista/loading.gif
new file mode 100644
index 00000000..2a96840f
Binary files /dev/null and b/help/css/dynatree/vista/loading.gif differ
diff --git a/help/css/dynatree/vista/ui.dynatree.css b/help/css/dynatree/vista/ui.dynatree.css
new file mode 100644
index 00000000..3dc5fb7e
--- /dev/null
+++ b/help/css/dynatree/vista/ui.dynatree.css
@@ -0,0 +1,452 @@
+/*******************************************************************************
+ * Tree container
+ */
+ul.dynatree-container
+{
+ font-family: tahoma, arial, helvetica;
+ font-size: 10pt; /* font size should not be too big */
+ white-space: nowrap;
+ padding: 3px;
+ margin: 0; /* issue 201 */
+ background-color: white;
+ border: 1px dotted gray;
+ overflow: auto;
+ height: 100%; /* issue 263 */
+}
+
+ul.dynatree-container ul
+{
+ padding: 0 0 0 16px;
+ margin: 0;
+}
+
+ul.dynatree-container li
+{
+ list-style-image: none;
+ list-style-position: outside;
+ list-style-type: none;
+ -moz-background-clip:border;
+ -moz-background-inline-policy: continuous;
+ -moz-background-origin: padding;
+ background-attachment: scroll;
+ background-color: transparent;
+ background-position: 0 0;
+ background-repeat: repeat-y;
+ background-image: none; /* no v-lines */
+
+ margin:0;
+ padding:1px 0 0 0;
+}
+/* Suppress lines for last child node */
+ul.dynatree-container li.dynatree-lastsib
+{
+ background-image: none;
+}
+/* Suppress lines if level is fixed expanded (option minExpandLevel) */
+ul.dynatree-no-connector > li
+{
+ background-image: none;
+}
+
+/* Style, when control is disabled */
+.ui-dynatree-disabled ul.dynatree-container
+{
+ opacity: 0.5;
+/* filter: alpha(opacity=50); /* Yields a css warning */
+ background-color: silver;
+}
+
+
+/*******************************************************************************
+ * Common icon definitions
+ */
+span.dynatree-empty,
+span.dynatree-vline,
+span.dynatree-connector,
+span.dynatree-expander,
+span.dynatree-icon,
+span.dynatree-checkbox,
+span.dynatree-radio,
+span.dynatree-drag-helper-img,
+#dynatree-drop-marker
+{
+ width: 16px;
+ height: 16px;
+/* display: -moz-inline-box; /* @ FF 1+2 removed for issue 221*/
+/* -moz-box-align: start; /* issue 221 */
+ display: inline-block; /* Required to make a span sizeable */
+ vertical-align: top;
+ background-repeat: no-repeat;
+ background-position: left;
+ background-image: url("icons.gif");
+ background-position: 0 0;
+}
+
+/** Used by 'icon' node option: */
+ul.dynatree-container img
+{
+ width: 16px;
+ height: 16px;
+ margin-left: 3px;
+ vertical-align: top;
+ border-style: none;
+}
+
+
+/*******************************************************************************
+ * Lines and connectors
+ */
+
+/*
+span.dynatree-empty
+{
+}
+span.dynatree-vline
+{
+}
+*/
+span.dynatree-connector
+{
+ background-image: none;
+}
+/*
+.dynatree-lastsib span.dynatree-connector
+{
+}
+*/
+/*******************************************************************************
+ * Expander icon
+ * Note: IE6 doesn't correctly evaluate multiples class names,
+ * so we create combined class names that can be used in the CSS.
+ *
+ * Prefix: dynatree-exp-
+ * 1st character: 'e': expanded, 'c': collapsed
+ * 2nd character (optional): 'd': lazy (Delayed)
+ * 3rd character (optional): 'l': Last sibling
+ */
+
+span.dynatree-expander
+{
+ background-position: 0px -80px;
+ cursor: pointer;
+}
+span.dynatree-expander:hover
+{
+ background-position: -16px -80px;
+}
+.dynatree-exp-cl span.dynatree-expander /* Collapsed, not delayed, last sibling */
+{
+}
+.dynatree-exp-cd span.dynatree-expander /* Collapsed, delayed, not last sibling */
+{
+}
+.dynatree-exp-cdl span.dynatree-expander /* Collapsed, delayed, last sibling */
+{
+}
+.dynatree-exp-e span.dynatree-expander, /* Expanded, not delayed, not last sibling */
+.dynatree-exp-ed span.dynatree-expander, /* Expanded, delayed, not last sibling */
+.dynatree-exp-el span.dynatree-expander, /* Expanded, not delayed, last sibling */
+.dynatree-exp-edl span.dynatree-expander /* Expanded, delayed, last sibling */
+{
+ background-position: -32px -80px;
+}
+.dynatree-exp-e span.dynatree-expander:hover, /* Expanded, not delayed, not last sibling */
+.dynatree-exp-ed span.dynatree-expander:hover, /* Expanded, delayed, not last sibling */
+.dynatree-exp-el span.dynatree-expander:hover, /* Expanded, not delayed, last sibling */
+.dynatree-exp-edl span.dynatree-expander:hover /* Expanded, delayed, last sibling */
+{
+ background-position: -48px -80px;
+}
+.dynatree-loading span.dynatree-expander /* 'Loading' status overrides all others */
+{
+ background-position: 0 0;
+ background-image: url("loading.gif");
+}
+
+
+/*******************************************************************************
+ * Checkbox icon
+ */
+span.dynatree-checkbox
+{
+ margin-left: 3px;
+ background-position: 0px -32px;
+}
+span.dynatree-checkbox:hover
+{
+ background-position: -16px -32px;
+}
+
+.dynatree-partsel span.dynatree-checkbox
+{
+ background-position: -64px -32px;
+}
+.dynatree-partsel span.dynatree-checkbox:hover
+{
+ background-position: -80px -32px;
+}
+
+.dynatree-selected span.dynatree-checkbox
+{
+ background-position: -32px -32px;
+}
+.dynatree-selected span.dynatree-checkbox:hover
+{
+ background-position: -48px -32px;
+}
+
+/*******************************************************************************
+ * Radiobutton icon
+ * This is a customization, that may be activated by overriding the 'checkbox'
+ * class name as 'dynatree-radio' in the tree options.
+ */
+span.dynatree-radio
+{
+ margin-left: 3px;
+ background-position: 0px -48px;
+}
+span.dynatree-radio:hover
+{
+ background-position: -16px -48px;
+}
+
+.dynatree-partsel span.dynatree-radio
+{
+ background-position: -64px -48px;
+}
+.dynatree-partsel span.dynatree-radio:hover
+{
+ background-position: -80px -48px;
+}
+
+.dynatree-selected span.dynatree-radio
+{
+ background-position: -32px -48px;
+}
+.dynatree-selected span.dynatree-radio:hover
+{
+ background-position: -48px -48px;
+}
+
+/*******************************************************************************
+ * Node type icon
+ * Note: IE6 doesn't correctly evaluate multiples class names,
+ * so we create combined class names that can be used in the CSS.
+ *
+ * Prefix: dynatree-ico-
+ * 1st character: 'e': expanded, 'c': collapsed
+ * 2nd character (optional): 'f': folder
+ */
+
+span.dynatree-icon /* Default icon */
+{
+ margin-left: 3px;
+ background-position: 0px 0px;
+}
+
+.dynatree-has-children span.dynatree-icon /* Default icon */
+{
+/* background-position: 0px -16px; */
+}
+
+.dynatree-ico-cf span.dynatree-icon /* Collapsed Folder */
+{
+ background-position: 0px -16px;
+}
+
+.dynatree-ico-ef span.dynatree-icon /* Expanded Folder */
+{
+ background-position: -64px -16px;
+}
+
+/* Status node icons */
+
+.dynatree-statusnode-wait span.dynatree-icon
+{
+ background-image: url("loading.gif");
+}
+
+.dynatree-statusnode-error span.dynatree-icon
+{
+ background-position: 0px -112px;
+/* background-image: url("ltError.gif");*/
+}
+
+/*******************************************************************************
+ * Node titles
+ */
+
+/* @Chrome: otherwise hit area of node titles is broken (issue 133)
+ Removed again for issue 165; (133 couldn't be reproduced) */
+span.dynatree-node
+{
+/* display: -moz-inline-box; /* issue 133, 165, 172, 192. removed for issue 221 */
+/* -moz-box-align: start; /* issue 221 */
+/* display: inline-block; /* Required to make a span sizeable */
+}
+
+
+/* Remove blue color and underline from title links */
+ul.dynatree-container a
+/*, ul.dynatree-container a:visited*/
+{
+ color: black; /* inherit doesn't work on IE */
+ text-decoration: none;
+ vertical-align: top;
+ margin: 0px;
+ margin-left: 3px;
+/* outline: 0; /* @ Firefox, prevent dotted border after click */
+ /* Set transparent border to prevent jumping when active node gets a border
+ (we can do this, because this theme doesn't use vertical lines)
+ */
+ border: 1px solid white; /* Note: 'transparent' would not work in IE6 */
+
+}
+
+ul.dynatree-container a:hover
+{
+/* text-decoration: underline; */
+ background: #F2F7FD; /* light blue */
+ border-color: #B8D6FB; /* darker light blue */
+}
+
+span.dynatree-node a
+{
+ display: inline-block; /* Better alignment, when title contains */
+/* vertical-align: top;*/
+ padding-left: 3px;
+ padding-right: 3px; /* Otherwise italic font will be outside bounds */
+ /* line-height: 16px; /* should be the same as img height, in case 16 px */
+}
+span.dynatree-folder a
+{
+/* font-weight: bold; */ /* custom */
+}
+
+ul.dynatree-container a:focus,
+span.dynatree-focused a:link /* @IE */
+{
+ background-color: #EFEBDE; /* gray */
+}
+
+span.dynatree-has-children a
+{
+/* font-style: oblique; /* custom: */
+}
+
+span.dynatree-expanded a
+{
+}
+
+span.dynatree-selected a
+{
+/* color: green; */
+ font-style: italic;
+}
+
+span.dynatree-active a
+{
+ border: 1px solid #99DEFD;
+ background-color: #D8F0FA;
+}
+
+/*******************************************************************************
+ * Drag'n'drop support
+ */
+
+/*** Helper object ************************************************************/
+div.dynatree-drag-helper
+{
+}
+div.dynatree-drag-helper a
+{
+ border: 1px solid gray;
+ background-color: white;
+ padding-left: 5px;
+ padding-right: 5px;
+ opacity: 0.8;
+}
+span.dynatree-drag-helper-img
+{
+ /*
+ position: relative;
+ left: -16px;
+ */
+}
+div.dynatree-drag-helper /*.dynatree-drop-accept*/
+{
+/* border-color: green;
+ background-color: red;*/
+}
+div.dynatree-drop-accept span.dynatree-drag-helper-img
+{
+ background-position: -32px -112px;
+}
+div.dynatree-drag-helper.dynatree-drop-reject
+{
+ border-color: red;
+}
+div.dynatree-drop-reject span.dynatree-drag-helper-img
+{
+ background-position: -16px -112px;
+}
+
+/*** Drop marker icon *********************************************************/
+
+#dynatree-drop-marker
+{
+ width: 24px;
+ position: absolute;
+ background-position: 0 -128px;
+ margin: 0;
+}
+#dynatree-drop-marker.dynatree-drop-after,
+#dynatree-drop-marker.dynatree-drop-before
+{
+ width:64px;
+ background-position: 0 -144px;
+}
+#dynatree-drop-marker.dynatree-drop-copy
+{
+ background-position: -64px -128px;
+}
+#dynatree-drop-marker.dynatree-drop-move
+{
+ background-position: -64px -128px;
+}
+
+/*** Source node while dragging ***********************************************/
+
+span.dynatree-drag-source
+{
+ /* border: 1px dotted gray; */
+ background-color: #e0e0e0;
+}
+span.dynatree-drag-source a
+{
+ color: gray;
+}
+
+/*** Target node while dragging cursor is over it *****************************/
+
+span.dynatree-drop-target
+{
+ /*border: 1px solid gray;*/
+}
+span.dynatree-drop-target a
+{
+}
+span.dynatree-drop-target.dynatree-drop-accept a
+{
+ /*border: 1px solid green;*/
+ background-color: #3169C6 !important;
+ color: white !important; /* @ IE6 */
+ text-decoration: none;
+}
+span.dynatree-drop-target.dynatree-drop-reject
+{
+ /*border: 1px solid red;*/
+}
+span.dynatree-drop-target.dynatree-drop-after a
+{
+}
diff --git a/help/css/hnd.css b/help/css/hnd.css
index efda37ea..ffb2cd1b 100644
--- a/help/css/hnd.css
+++ b/help/css/hnd.css
@@ -36,24 +36,24 @@ a.rvts5, span.rvts5 /* Jump 2 */
}
span.rvts6
{
- color: #aca899;
+ color: #71593e;
}
span.rvts7
{
font-size: 15pt;
font-family: 'Tahoma', 'Geneva', sans-serif;
font-weight: bold;
- color: #716f64;
+ color: #404040;
}
span.rvts8
{
font-weight: bold;
- color: #aca899;
+ color: #71593e;
}
span.rvts9
{
font-style: italic;
- color: #aca899;
+ color: #71593e;
}
span.rvts10
{
@@ -132,106 +132,107 @@ span.rvts25
}
a.rvts26, span.rvts26
{
+ font-size: 12pt;
color: #0000ff;
text-decoration: underline;
}
a.rvts26:hover { color: #0000ff; }
-span.rvts27
-{
- font-size: 8pt;
- font-family: 'Courier New', 'Courier', monospace;
-}
-a.rvts28, span.rvts28
+a.rvts27, span.rvts27
{
font-size: 12pt;
color: #0000ff;
text-decoration: underline;
}
-a.rvts28:hover { color: #0000ff; }
-a.rvts29, span.rvts29
-{
- font-size: 12pt;
- color: #0000ff;
- text-decoration: underline;
-}
-a.rvts29:hover { color: #0000ff; }
-span.rvts30
+a.rvts27:hover { color: #0000ff; }
+span.rvts28
{
font-size: 16pt;
}
-span.rvts31
+span.rvts29
{
font-family: 'Lucida Console', 'Monaco', monospace;
}
-span.rvts32
+span.rvts30
{
font-style: italic;
}
-span.rvts33
+span.rvts31
{
font-family: 'Times New Roman', 'Times', serif;
}
-span.rvts34
+span.rvts32
{
font-size: 11pt;
font-family: 'Courier New', 'Courier', monospace;
}
-span.rvts35
+span.rvts33
{
font-size: 16pt;
text-decoration: underline;
}
-a.rvts36, span.rvts36
+a.rvts34, span.rvts34
{
font-size: 12pt;
color: #0000ff;
text-decoration: underline;
}
-a.rvts36:hover { color: #0000ff; }
-span.rvts37
+a.rvts34:hover { color: #0000ff; }
+span.rvts35
{
font-size: 24pt;
}
-span.rvts38
+span.rvts36
{
font-size: 14pt;
text-decoration: underline;
}
-span.rvts39
+span.rvts37
{
font-family: 'Courier New', 'Courier', monospace;
}
-span.rvts40
+span.rvts38
{
font-weight: bold;
}
-span.rvts41
+span.rvts39
{
font-size: 9pt;
}
-a.rvts42, span.rvts42
+a.rvts40, span.rvts40
{
font-size: 9pt;
color: #0000ff;
text-decoration: underline;
}
-a.rvts42:hover { color: #0000ff; }
-a.rvts43, span.rvts43
+a.rvts40:hover { color: #0000ff; }
+a.rvts41, span.rvts41
{
font-size: 12pt;
color: #0000ff;
text-decoration: underline;
}
-a.rvts43:hover { color: #0000ff; }
-span.rvts44
+a.rvts41:hover { color: #0000ff; }
+span.rvts42
{
font-size: 12pt;
font-weight: bold;
}
+span.rvts43
+{
+ font-size: 12pt;
+ font-weight: bold;
+ text-decoration: underline;
+}
+a.rvts44, span.rvts44
+{
+ font-size: 12pt;
+ color: #0000ff;
+ text-decoration: underline;
+}
+a.rvts44:hover { color: #0000ff; }
span.rvts45
{
- font-size: 12pt;
- font-weight: bold;
+ font-size: 22pt;
text-decoration: underline;
}
a.rvts46, span.rvts46
@@ -243,135 +244,123 @@ a.rvts46, span.rvts46
a.rvts46:hover { color: #0000ff; }
span.rvts47
{
- font-size: 22pt;
- text-decoration: underline;
+ font-size: 18pt;
+ font-weight: bold;
}
-a.rvts48, span.rvts48
+span.rvts48
{
font-size: 12pt;
- color: #0000ff;
- text-decoration: underline;
+ font-family: 'Courier New', 'Courier', monospace;
+ font-weight: bold;
}
-a.rvts48:hover { color: #0000ff; }
span.rvts49
{
- font-size: 18pt;
+ font-size: 14pt;
font-weight: bold;
}
span.rvts50
-{
- font-size: 12pt;
- font-family: 'Courier New', 'Courier', monospace;
- font-weight: bold;
-}
-span.rvts51
-{
- font-size: 14pt;
- font-weight: bold;
-}
-span.rvts52
{
font-size: 12pt;
font-family: 'Courier New', 'Courier', monospace;
color: #000080;
}
-span.rvts53
+span.rvts51
{
font-size: 12pt;
font-family: 'Courier New', 'Courier', monospace;
color: #333399;
}
-span.rvts54
+span.rvts52
{
font-size: 14pt;
font-family: 'Courier New', 'Courier', monospace;
font-weight: bold;
}
-span.rvts55
+span.rvts53
{
font-family: 'Courier New', 'Courier', monospace;
color: #000080;
}
-span.rvts56
+span.rvts54
{
font-size: 16pt;
font-family: 'Courier New', 'Courier', monospace;
font-weight: bold;
}
-span.rvts57
+span.rvts55
{
font-size: 11pt;
font-family: 'Courier New', 'Courier', monospace;
font-weight: bold;
}
-span.rvts58
+span.rvts56
{
font-family: 'Courier New', 'Courier', monospace;
font-weight: bold;
}
-span.rvts59
+span.rvts57
{
font-family: 'Courier New', 'Courier', monospace;
}
-span.rvts60
+span.rvts58
{
font-size: 12pt;
font-family: 'Courier New', 'Courier', monospace;
color: #000080;
}
-a.rvts61, span.rvts61
+a.rvts59, span.rvts59
{
font-family: 'Courier New', 'Courier', monospace;
color: #0000ff;
text-decoration: underline;
}
-a.rvts61:hover { color: #0000ff; }
-a.rvts62, span.rvts62
+a.rvts59:hover { color: #0000ff; }
+a.rvts60, span.rvts60
{
font-size: 12pt;
color: #0000ff;
text-decoration: underline;
}
-a.rvts62:hover { color: #0000ff; }
-span.rvts63
+a.rvts60:hover { color: #0000ff; }
+span.rvts61
{
font-family: 'Lucida Console', 'Monaco', monospace;
text-decoration: underline;
}
-span.rvts64
+span.rvts62
{
font-style: italic;
font-weight: bold;
}
-span.rvts65
+span.rvts63
{
font-weight: bold;
text-decoration: underline;
}
-span.rvts66
+span.rvts64
{
font-size: 11pt;
text-decoration: underline;
}
-span.rvts67
+span.rvts65
{
font-size: 5pt;
}
+span.rvts66
+{
+ font-size: 4pt;
+}
+span.rvts67
+{
+ font-size: 4pt;
+ font-weight: bold;
+}
span.rvts68
-{
- font-size: 4pt;
-}
-span.rvts69
-{
- font-size: 4pt;
- font-weight: bold;
-}
-span.rvts70
{
font-size: 5pt;
font-weight: bold;
}
-span.rvts71
+span.rvts69
{
font-size: 11pt;
font-weight: bold;
diff --git a/help/css/ielte8.css b/help/css/ielte8.css
index d40a15dd..db7f3702 100644
--- a/help/css/ielte8.css
+++ b/help/css/ielte8.css
@@ -1,8 +1,3 @@
-#tabs .ui-tabs-panel {
- padding-top: 10px;
-}
-
-#topic_content, #topic_footer,
-#toc_content, #toc_footer {
- width: 100%;
+.ui-tabs .ui-tabs-nav {
+ padding: 0;
}
\ No newline at end of file
diff --git a/help/css/toc.css b/help/css/toc.css
index 2f7ec770..9fff9af7 100644
--- a/help/css/toc.css
+++ b/help/css/toc.css
@@ -1,65 +1,71 @@
-/* UI Tabs */
+/* -- Body -- */
-.ui-tabs-nav {
- border-top: 0;
- border-right: 0;
- border-left: 0;
+body {
+ overflow: hidden;
}
-/* TreeView */
+/* -- UI Tabs -- */
-.treeview, .treeview ul {
- list-style: none;
+ul.dynatree-container {
+ line-height: 1.5em;
}
-.treeview ul {
- margin-top: 4px;
+.ui-tabs {
+ position: static;
}
-.treeview .hitarea {
- background: url(../img/treeview-default.gif) -64px -25px no-repeat;
- height: 16px;
- width: 16px;
- margin-left: -16px;
- float: left;
- cursor: pointer;
-}
-/* fix for IE6 */
-* html .hitarea {
- display: inline;
- float:none;
+#toc_header {
+ padding-bottom: 0;
}
-.treeview li {
- margin: 0;
- padding: 3px 0pt 3px 16px;
+#tabs .ui-tabs-nav {
+ border: 0;
+ border-bottom: 1px solid #ccc;
+ padding-top: 19px;
+ position: absolute;
+ top: 0;
+ left: 0;
+ width: 100%;
}
-.filetree a{ text-decoration: none; }
+#tabs .ui-widget-header{
+ background: #fff url(../img/header-bg.png) left bottom repeat-x;
+}
-.filetree a:hover { text-decoration: underline; }
+#tabs .ui-tabs-panel {
+ overflow: auto;
+ position: absolute;
+ top: 43px;
+ left: 0;
+ right: 0;
+ bottom: 0;
+}
-#treecontrol { margin: 1em 0; display: none; }
+/* Search */
-.treeview li { background: url(../img/treeview-default-line.gif) 0 0 no-repeat; }
-.treeview li.collapsable, .treeview li.expandable { background-position: 0 -176px; }
+#search_value {
+ width: 140px;
+}
-.treeview .expandable-hitarea { background-position: -80px -3px; }
+#search_results {
+ padding-top: 10px;
+}
-.treeview li.last { background-position: 0 -1766px }
-.treeview li.lastCollapsable, .treeview li.lastExpandable { background-image: url(../img/treeview-default.gif); }
-.treeview li.lastCollapsable { background-position: 0 -111px }
-.treeview li.lastExpandable { background-position: -32px -67px }
+/* -- Tree -- */
-.treeview div.lastCollapsable-hitarea, .treeview div.lastExpandable-hitarea { background-position: 0; }
+ul.dynatree-container {
+ border: 0;
+ font-family: inherit;
+ overflow: visible;
+ padding: 0;
+}
-.filetree li { padding: 3px 0 2px 16px; }
-.filetree span.folder, .filetree span.file, .filetree a.folder, .filetree a.file { padding: 1px 0 1px 20px; display: block; }
+/* Selection color */
+span.dynatree-active a {
+ background-color: #999999 !important;
+}
-.toctree span.folder, .toctree a.folder { background: url(../img/book.png) 0 0 no-repeat; }
-.toctree li.expandable span.folder, .toctree li.expandable a.folder { background: url(../img/book-closed.png) 0 0 no-repeat; }
-.toctree span.file, .toctree a.file { background: url(../img/topic.png) 0 0 no-repeat; }
-
-.indextree span.folder, .indextree a.folder { background: url(../img/topic.png) 0 0 no-repeat; }
-.indextree li.expandable span.folder, .indextree li.expandable a.folder { background: url(../img/topic.png) 0 0 no-repeat; }
-.indextree span.file, .indextree a.file { background: url(../img/topic.png) 0 0 no-repeat; }
\ No newline at end of file
+/* Remove folder boldness */
+span.dynatree-folder a {
+ font-weight: normal;
+}
\ No newline at end of file
diff --git a/help/fcm.html b/help/fcm.html
index 3475d951..f3996847 100644
--- a/help/fcm.html
+++ b/help/fcm.html
@@ -10,14 +10,24 @@
+
diff --git a/help/fcs.html b/help/fcs.html
index a492f65f..3bb80a1c 100644
--- a/help/fcs.html
+++ b/help/fcs.html
@@ -10,14 +10,24 @@
+
diff --git a/help/fm2.html b/help/fm2.html
index d9d11fc1..0225c066 100644
--- a/help/fm2.html
+++ b/help/fm2.html
@@ -10,14 +10,24 @@
+
@@ -48,12 +58,14 @@
FCEUX uses a new movie file format - .fm2.
This differs from the previous FCE Ultra movie format (.fcm) in the following ways:
-
-
It is text based by default; allowing easy movie editing/splicing
-
An imbedded GUID so FCEUX can tell if a savestate belongs to a movie file
-
Movies recorded from Start (Power-on) no longer have a redundant savestate
-
Contains mouse input for recording the Zapper & Arkanoid Paddle
-
+
●
+It is text based by default; allowing easy movie editing/splicing
+
●
+An imbedded GUID so FCEUX can tell if a savestate belongs to a movie file
+
●
+Movies recorded from Start (Power-on) no longer have a redundant savestate
+
●
+Contains mouse input for recording the Zapper & Arkanoid Paddle
Format
@@ -62,7 +74,7 @@
The header is always in ASCII plain text format. It consists of several key-value pairs.
The input log section can be identified by it starting with a | (pipe).
The input log section can be either in ASCII plain text format or in binary format.
-
The input log section terminates at EOF, unless the length key is specified in header.
+
The input log section terminates at EOF, unless the length key is specified in header.
Newlines may be \r\n or \n.
@@ -75,71 +87,71 @@
Integer keys (also used for booleans, with a 1 for true and 0 for false) must have a value that can be stored as int32:
-
- version (required) - the version of the movie file format; for now it is always 3
-
-
- emuVersion (required) - the version of the emulator used to produce the movie
-
-
- rerecordCount (optional) - the rerecord count
-
-
- palFlag (bool) (optional) - true if the movie uses PAL timing
-
-
- NewPPU (bool) (optional) - true if the movie uses New PPU
-
-
- FDS (bool) (optional) - true if movie was recorded on a Famicom Disk System (FDS) game
-
-
- fourscore (bool) - true if a fourscore was used. If fourscore is not used, then port0 and port1 are required
-
-
- port0 - indicates the type of input device attached to the port 0. Supported values are:
+
- version (required) - the version of the movie file format; for now it is always 3
+
+
- emuVersion (required) - the version of the emulator used to produce the movie
+
+
- rerecordCount (optional) - the rerecord count
+
+
- palFlag (bool) (optional) - true if the movie uses PAL timing
+
+
- NewPPU (bool) (optional) - true if the movie uses New PPU
+
+
- FDS (bool) (optional) - true if movie was recorded on a Famicom Disk System (FDS) game
+
+
- fourscore (bool) - true if a fourscore was used. If fourscore is not used, then port0 and port1 are required
+
+
- port0 - indicates the type of input device attached to the port 0. Supported values are:
SI_NONE = 0
SI_GAMEPAD = 1
SI_ZAPPER = 2
-
-
- port1 - indicates the type of input device attached to the port 1. Supported values are:
+
+
- port1 - indicates the type of input device attached to the port 1. Supported values are:
SI_NONE = 0
SI_GAMEPAD = 1
SI_ZAPPER = 2
-
-
- port2 (required) - indicates the type of the FCExp port device which was attached. Supported values are:
+
+
- port2 (required) - indicates the type of the FCExp port device which was attached. Supported values are:
SIFC_NONE = 0
-
-
- binary (bool) (optional) - true if input log is stored in binary format
-
-
- length (optional) - movie size (number of frames in the input log). If this key is specified and the number is >= 0, the input log ends after specified number of records, and any remaining data should not be parsed. This key is used in fm3 format to allow storing extra data after the end of input log
+
+
- binary (bool) (optional) - true if input log is stored in binary format
+
+
- length (optional) - movie size (number of frames in the input log). If this key is specified and the number is >= 0, the input log ends after specified number of records, and any remaining data should not be parsed. This key is used in fm3 format to allow storing extra data after the end of input log
String keys have values that consist of the remainder of the key-value pair line. As a consequence, string values cannot contain newlines.
-
- romFilename (required) - the name of the file used to record the movie
-
-
- comment (optional) - simply a memo
-
-
by convention, the first token in the comment value is the subject of the comment
-
by convention, subsequent comments with the same subject should have their ordering preserved and may be used to approximate multi-line comments
-
by convention, the author of the movie should be stored in comment(s) with a subject of: author
-
+
- romFilename (required) - the name of the file used to record the movie
+
+
- comment (optional) - simply a memo
+
o
+by convention, the first token in the comment value is the subject of the comment
+
o
+by convention, subsequent comments with the same subject should have their ordering preserved and may be used to approximate multi-line comments
+
o
+by convention, the author of the movie should be stored in comment(s) with a subject of: author
Example:
-
-
comment author adelikat
-
-
-
- subtitle (optional) - a message that will be displayed on screen when movie is played back (unless Subtitles are turned off, see Movie options)
-
-
by convention, subtitles begin with the word "subtitle"
-
by convention, an integer value following the word "subtitle" indicates the frame that the subtitle will be displayed
-
by convention, any remaining text after the integer is considered to be the string displayed
-
+
♦
+comment author adelikat
+
+
- subtitle (optional) - a message that will be displayed on screen when movie is played back (unless Subtitles are turned off, see Movie options)
+
o
+by convention, subtitles begin with the word "subtitle"
+
o
+by convention, an integer value following the word "subtitle" indicates the frame that the subtitle will be displayed
+
o
+by convention, any remaining text after the integer is considered to be the string displayed
Example:
-
-
subtitle 1000 Level Two
-
+
♦
+subtitle 1000 Level Two
At frame 1000 the words "Level Two" will be displayed on the screen
-
-
- guid (required) - a unique identifier for a movie, generated when the movie is created, which is used when loading a savestate to make sure it belongs to the current movie
+
+
- guid (required) - a unique identifier for a movie, generated when the movie is created, which is used when loading a savestate to make sure it belongs to the current movie
GUID keys have a value which is in the standard guide format: 452DE2C3-EF43-2FA9-77AC-0677FC51543B
-
-
- romChecksum (required) - the MD5 hash of the ROM which was used to record the movie
-
-
- savestate (optional) - a fcs savestate blob, in case a movie was recorded from savestate
+
+
- romChecksum (required) - the MD5 hash of the ROM which was used to record the movie
+
+
- savestate (optional) - a fcs savestate blob, in case a movie was recorded from savestate
Hex string keys (used for binary blobs) have a value that is like 0x0123456789ABCDEF...
@@ -148,92 +160,98 @@
The input log section consists of movie records either in the form of text lines or in the form of binary data.
-
Text format (default format):
+
Text format (default format):
Every frame of the movie is represented by line of text beginning and ending with a | (pipe).
The fields in the line are as follows, except when fourscore is used.
-
|commands|port0|port1|port2|
+
|commands|port0|port1|port2|
-
Field commands is a variable length decimal integer which is interpreted as a bit field corresponding to miscellaneous input states which are valid at the start of the frame. Current values for this are:
-
-
1 = Soft Reset
-
2 = Hard Reset (Power)
-
4 = FDS Disk Insert
-
8 = FDS Disk Select
-
+
Field commands is a variable length decimal integer which is interpreted as a bit field corresponding to miscellaneous input states which are valid at the start of the frame. Current values for this are:
+
●
+1 = Soft Reset
+
●
+2 = Hard Reset (Power)
+
●
+4 = FDS Disk Insert
+
●
+8 = FDS Disk Select
The format of port0, port1, port2 depends on which types of devices were attached.
SI_GAMEPAD:
-
-
the field consists of eight characters which constitute a bit field
-
any character other than ' ' or '.' means that the button was pressed
-
by convention, the following mnemonics are used in a column to remind us of which button corresponds to which column: RLDUTSBA (Right, Left, Down, Up, sTart, Select, B, A)
-
+
●
+the field consists of eight characters which constitute a bit field
+
●
+any character other than ' ' or '.' means that the button was pressed
+
●
+by convention, the following mnemonics are used in a column to remind us of which button corresponds to which column: RLDUTSBA (Right, Left, Down, Up, sTart, Select, B, A)
SI_ZAPPER:
-
-
XXX YYY B Q Z
-
-
XXX: %03d, the x position of the mouse
-
YYY: %03d, the y position of the mouse
-
B: %1d, 1 if the mouse button is pressed; 0 if not
-
Q: %1d, an internal value used by the emulator's zapper code
-
Z: %d, a variable-length decimal integer; an internal value used by the emulator's zapper code
+
●
+XXX YYY B Q Z
+
XXX: %03d, the x position of the mouse
+
YYY: %03d, the y position of the mouse
+
B: %1d, 1 if the mouse button is pressed; 0 if not
+
Q: %1d, an internal value used by the emulator's zapper code
+
Z: %d, a variable-length decimal integer; an internal value used by the emulator's zapper code
SI_NONE:
-
-
the field must be empty
-
+
●
+the field must be empty
-
If a fourscore is used, then port0 and port1 are irrelevant and ignored.
+
If a fourscore is used, then port0 and port1 are irrelevant and ignored.
The input types must all be gamepads, and each input log record must be in the following format:
Every frame of the movie is represented by a record of a fixed length which can be determined by the devices on port0 and port1.
The first byte of each record stores "commands" bit field.
-
-
bit 0 = Soft Reset
-
bit 1 = Hard Reset (Power)
-
bit 2 = FDS Disk Insert
-
bit 3 = FDS Disk Select
-
+
●
+bit 0 = Soft Reset
+
●
+bit 1 = Hard Reset (Power)
+
●
+bit 2 = FDS Disk Insert
+
●
+bit 3 = FDS Disk Select
The remaining bytes in the record depend on which types of devices are attached to port0 and port1.
SI_GAMEPAD:
-
-
1 byte added to the size of record
-
bits of the byte represent the state of buttons (bit0 = A, bit1 = B, bit2 = Select, bit3 = sTart, bit4 = Up, bit5 = Down, bit6 = Left, bit7 = Right). If the bit is set, respective button is considered to be pressed, if the bit is clear, the button is not pressed
-
+
●
+1 byte added to the size of record
+
●
+bits of the byte represent the state of buttons (bit0 = A, bit1 = B, bit2 = Select, bit3 = sTart, bit4 = Up, bit5 = Down, bit6 = Left, bit7 = Right). If the bit is set, respective button is considered to be pressed, if the bit is clear, the button is not pressed
SI_ZAPPER:
-
-
12 bytes added to the size of record
-
1st byte - the x position of the mouse
-
2nd byte - the y position of the mouse
-
3rd byte - 1 if the mouse button is pressed; 0 if not
-
4th byte - an internal value used by the emulator's zapper code
-
bytes 5-12 (uint64) - an internal value used by the emulator's zapper code
-
+
●
+12 bytes added to the size of record
+
●
+1st byte - the x position of the mouse
+
●
+2nd byte - the y position of the mouse
+
●
+3rd byte - 1 if the mouse button is pressed; 0 if not
+
●
+4th byte - an internal value used by the emulator's zapper code
+
●
+bytes 5-12 (uint64) - an internal value used by the emulator's zapper code
SI_NONE:
-
-
0 bytes added to the size of record
-
+
●
+0 bytes added to the size of record
-
If a fourscore is used, then port0 and port1 are irrelevant and ignored. 4 bytes are added to the size of record. The bits of the 1st byte represent the state of buttons of the 1st joypad (bit0 = A, bit1 = B, bit2 = Select, bit3 = sTart, bit4 = Up, bit5 = Down, bit6 = Left, bit7 = Right); bits of the 2nd byte represent the state of buttons of the 2nd joypad, and so on.
+
If a fourscore is used, then port0 and port1 are irrelevant and ignored. 4 bytes are added to the size of record. The bits of the 1st byte represent the state of buttons of the 1st joypad (bit0 = A, bit1 = B, bit2 = Select, bit3 = sTart, bit4 = Up, bit5 = Down, bit6 = Left, bit7 = Right); bits of the 2nd byte represent the state of buttons of the 2nd joypad, and so on.
-
Notes:
-
+
Notes:
+
A. All movies start from power-on, unless a savestate key-value is present.