diff --git a/help/Commands.html b/help/Commands.html index 5d897a94..31c38d35 100644 --- a/help/Commands.html +++ b/help/Commands.html @@ -203,7 +203,7 @@

BIT(n); -- returns a number with only bit n set (1)


The emulator specific Lua is equal to the one of snes9x, with some platform specific changes (few buttons, for instance).

-

You can find the reference here: http://dehacked.2y.net/snes9x-lua.html

+

You can find the reference here: http://dehacked.2y.net/snes9x-lua.html

The following is a quick reference, you can go to the snes9x reference for more details.


To paint stuff on screen, use the gui table. This contains a few predefined functions to manipulate the main window. For any coordinate, 0,0 is the top-left pixel of the window. You have to prevent out-of-bound errors yourself for now. If a color can be passed on, it is a string. HTML-syntax is supported ("#34053D"), as well as a FEW colors ("red", "green", "blue" ...).

diff --git a/help/FAQGuides.html b/help/FAQGuides.html index d13f1bd0..8b0f484f 100644 --- a/help/FAQGuides.html +++ b/help/FAQGuides.html @@ -56,22 +56,22 @@


Information regarding various concepts such as TAS, ROM Hacking, RAM Mapping.


-

Troubleshooting FAQ

+

Troubleshooting FAQ


A guide to common problems people experience, and what to do about them.



-

Tool Assisted Speedruns (TAS)

+

Tool Assisted Speedruns (TAS)


Information regarding Tool Assisted Speedruns and the TAS community.



-

ROM Hacking

+

ROM Hacking


Information regarding making ROM Hacks and the ROM Hacking community.



-

NES RAM Mapping

+

NES RAM Mapping


A guide to the layout of NES RAM, and how to interpret its contents.


diff --git a/help/LuaBot.html b/help/LuaBot.html index 22423606..d5d5c8a3 100644 --- a/help/LuaBot.html +++ b/help/LuaBot.html @@ -48,7 +48,7 @@ Previous - Next + Next
diff --git a/help/LuaFunctionsList.html b/help/LuaFunctionsList.html index 7fd9a4a9..7a153349 100644 --- a/help/LuaFunctionsList.html +++ b/help/LuaFunctionsList.html @@ -731,19 +731,19 @@


Bitwise Operations


-

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

+

The following bit functions were added to FCEUX internally to compensate for Lua's lack of them. But it also supports all operations from LuaBitOp module, since it is also 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.

+

Binary logical AND of all the given integers.


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.

+

Binary logical OR of all the given integers.


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.

+

Binary logical XOR of all the given integers.


int BIT(int n1, int n2, ..., int nn)


diff --git a/help/LuaPerks.html b/help/LuaPerks.html new file mode 100644 index 00000000..9a4a3c32 --- /dev/null +++ b/help/LuaPerks.html @@ -0,0 +1,124 @@ + + + + LuaPerks + + + + + + + + + + + + + + +
+
+

LuaPerks

+ +
+ Lua Scripting ››
+
+
+ Parent + + Previous + + Next + +
+
+
+
+ +

+

LuaPerks

+


+

FCEUX has several extension libraries integrated that are not included in LUA normally, but can be called from the external modules. These modules were collected into a common library called LuaPerks and built into FCEUX. The included libraries are very powerful compared to standard EmuLua functionality. Their functions can be called without using require.

+


+


+

IUP library

+


+

IUP (Portable User Interface) is a multi-platform toolkit for building graphical user interfaces.

+


+

Usage example: creating custom dialogs.

+


+

http://www.tecgraf.puc-rio.br/iup/

+


+


+

IM library

+


+

IM is a toolkit for Digital Imaging. IM is based on 4 concepts: Image Representation, Storage, Processing and Capture. The main goal of the library is to provide a simple API and abstraction of images for scientific applications.

+


+

The most popular file formats are supported: TIFF, BMP, PNG, JPEG, GIF and AVI. Image representation includes scientific data types. About a hundred Image Processing operations are available.

+


+

Usage example: dumping level maps during playing.

+


+

http://www.tecgraf.puc-rio.br/im/

+


+


+

CD library

+


+

CD (Canvas Draw) is a platform-independent graphics library. It is implemented in several platforms using native graphics libraries: Microsoft Windows (GDI) and X-Windows (XLIB).

+


+

The library contains functions to support both vector and image applications, and the visualization surface can be either a window or a more abstract surface, such as Image, Clipboard, Metafile, PS, and so on.

+


+

Usage example: drawing hitboxes over level maps.

+


+

http://www.tecgraf.puc-rio.br/cd/

+


+


+

LuaSocket library

+


+

LuaSocket is a Lua extension library that is composed by two parts: a C core that provides support for the TCP and UDP transport layers, and a set of Lua modules that add support for the SMTP (sending e-mails), HTTP (WWW access) and FTP (uploading and downloading files) protocols and other functionality commonly needed by applications that deal with the Internet.

+


+

Usage examples: netplay, local data transmission.

+


+

http://w3.impa.br/~diego/software/luasocket/home.html

+


+


+

WinAPI library

+


+

This module provides some basic tools for working with Windows systems, finding out system resources, and gives you more control over process creation. In this introduction any plain reference is in the winapi table, so that find_window means winapi.find_window. Normally winapi works with the current Windows code page, but can be told to use UTF-8 with @{set_encoding}; interally string operations are in Unicode.

+


+

Usage example: making the emulator window jumping.

+


+

https://github.com/stevedonovan/winapi

+


+

+

Created with the Personal Edition of HelpNDoc: Free EBook and documentation generator

+
+ + + + + + diff --git a/help/LuaScripting.html b/help/LuaScripting.html index c1eef564..4ded60a7 100644 --- a/help/LuaScripting.html +++ b/help/LuaScripting.html @@ -76,6 +76,10 @@

Lua Bot


How to use Luau's version of Basic bot.

+


+

LuaPerks

+


+

Additional libraries integrated into FCEUX.

Created with the Personal Edition of HelpNDoc: Free iPhone documentation generator

diff --git a/help/NESRAMMappingFindingValues.html b/help/NESRAMMappingFindingValues.html index fa71bc47..7ae32a62 100644 --- a/help/NESRAMMappingFindingValues.html +++ b/help/NESRAMMappingFindingValues.html @@ -232,7 +232,7 @@

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  

+

                           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

ID counter:       041x: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00

Timer/sp change:  042x: 02 00 00 00 00 03 03 03 03 00 00 00 00 00 00 00

diff --git a/help/OverviewofIncludedScripts.html b/help/OverviewofIncludedScripts.html index ba1dce72..d12fb79f 100644 --- a/help/OverviewofIncludedScripts.html +++ b/help/OverviewofIncludedScripts.html @@ -46,7 +46,7 @@
Parent - Previous + Previous Next diff --git a/help/css/hnd.css b/help/css/hnd.css index c3dc796b..f635a6f8 100644 --- a/help/css/hnd.css +++ b/help/css/hnd.css @@ -36,24 +36,24 @@ a.rvts5, span.rvts5 /* Jump 2 */ } span.rvts6 { - color: #a0a0a0; + color: #aca899; } span.rvts7 { font-size: 15pt; font-family: 'Tahoma', 'Geneva', sans-serif; font-weight: bold; - color: #696969; + color: #716f64; } span.rvts8 { font-weight: bold; - color: #a0a0a0; + color: #aca899; } span.rvts9 { font-style: italic; - color: #a0a0a0; + color: #aca899; } span.rvts10 { @@ -359,31 +359,37 @@ span.rvts69 } a.rvts70, span.rvts70 { - font-size: 12pt; color: #0000ff; text-decoration: underline; } a.rvts70:hover { color: #0000ff; } -span.rvts71 +a.rvts71, span.rvts71 +{ + font-size: 12pt; + color: #0000ff; + text-decoration: underline; +} +a.rvts71:hover { color: #0000ff; } +span.rvts72 { font-family: 'Lucida Console', 'Monaco', monospace; text-decoration: underline; } -span.rvts72 +span.rvts73 { font-weight: bold; text-decoration: underline; } -span.rvts73 +span.rvts74 { font-size: 11pt; text-decoration: underline; } -span.rvts74 +span.rvts75 { font-size: 5pt; } -span.rvts75 +span.rvts76 { font-size: 5pt; font-weight: bold; diff --git a/help/fm2.html b/help/fm2.html index 36cd91a9..b8753a95 100644 --- a/help/fm2.html +++ b/help/fm2.html @@ -90,41 +90,41 @@

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:

    SI_NONE = 0

    SI_GAMEPAD = 1

    SI_ZAPPER = 2

-


+


- 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:

    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

+


+

- 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