Neural Network Library

2018-02-17T18:55:05Z

Elverion: /* NeuralNet:save() */

Neural Network Library

2018-02-17T18:54:13Z

Elverion: /* NeuralNet:getExportTable() */

Neural Network Library

2018-02-17T18:54:00Z

2018-02-17T18:10:11Z

Elverion: Created page with "= What Neural Networks Can Do = = How It Works = = Documentation = ==Including the library in your project== ==Creating an instance of a neural network== ==NeuralNet:feed()=..."

= What Neural Networks Can Do =

= How It Works =

= Documentation =
==Including the library in your project==
==Creating an instance of a neural network==
==NeuralNet:feed()==
==NeuralNet:backPropagation()==
==NeuralNet:getRecentAverageError()==
==NeuralNet:getResults()==
==NeuralNet:getExportTable()==
==NeuralNet:save()==
==NeuralNet:load()==

= Examples =

Manual

2018-02-17T18:02:53Z

Elverion:

'''MicroMacro 2.x Online Manual'''

''The MicroMacro 2 branch is currently under development and is subject to change.''

{| class="wikitable" style="padding: 8px;"
|-
| style="width: 150px;" | [[Basic Info]]
| How things work, configuration options, and other fun stuff.
|-
| [[Tutorials & Examples]]
| Everything you'll want to know to get started writing your own script.
|-
| [[Events]]
| The different events that can be triggered.
|-
|
|-
| [[Audio Module]]
| Load and play sounds with OpenAL.
|-
| [[Class Module]]
| Create classes with support for object inheritance.
|-
| [[Cli Module]]
| For interfacing with the console.
|-
| [[Filesystem Module]]
| Functions for dealing with files and directories.
|-
| [[Gamepad Module]]
| Read input from gamepads and joysticks.
|-
| [[Global Addon]]
| Misc functions in global scope.
|-
| [[ Hash Module]]
| Functions for 1-way hashing strings and files.
|-
| [[Key Module]]
| A table containing virtual key codes for use with keyboard and mouse related functions.
|-
| [[Keyboard Module]]
| Read keyboard input or send synthetic key presses.
|-
| [[Log Module]]
| Functions for interfacing with the global log file.
|-
| [[Macro Module]]
| The base module; controls the execution of your scripts.
|-
| [[Math Addon]]
| Additional math functions.
|-
| [[Mouse Module]]
| Read mouse input or send synthetic button presses & movement.
|-
| [[Ncurses Module]]
| Create Ncurses windows and display text in an advanced way.
|-
| [[Network Module]]
| Communicate with overs over standard network sockets
|-
| [[Process Module]]
| Interface with other processes & their allocated memory.
|-
| [[SQL Module]]
| Query SQL relational databases.
|-
| [[String Addon]]
| Additional functions for working with text strings.
|-
| [[System Module]]
| Interfacing with the operating system.
|-
| [[Table Addon]]
| Additional functions for working with tables.
|-
| [[Time Module]]
| Anything dealing with timing & time values.
|-
| [[Window Module]]
| Interface with other windows.
|-
|
|-
| [[Cache Library]]
| For caching simple key/value pairs
|-
| [[HTTPD Library]]
| Run a mini-webserver and use your web browser to interface with your scripts
|-
| [[Neural Network Library]]
| Simple, open-ended machine learning
|-
| [[Timestamp Class]]
| A library to aid in dealing with time values
|-
| [[Timezone Class]]
| A library used to lookup timezone offsets
|}

'''MicroMacro 1.x Online Manual'''

{| class="wikitable" style="padding: 8px;"
|-
| style="width: 150px;" | [[Mouse Control]]
| Functions to control mouse movement and clicks
|-
| [[Keyboard Control]]
| Functions to control keyboard key presses and releases
|-
| [[Process Functions]]
| Functions to open, close, and find processes
|-
| [[Memory Functions]]
| Functions for reading and writing of memory
|-
| [[Network Functions]]
| Functions for sending and receiving data over TCP/IP
|-
| [[Filesystem Functions]]
| Functions for working with files and directories
|-
| [[Timer Functions]]
| Timer-related functions
|-
| [[Misc Functions|Misc. Functions]]
| Misc. functions
|-
| [[Sound Functions]]
| Functions for loading and playing sounds
|-
| [[Library]]
| Various library information
|-
| [[Modules]]
| Information about the standard modules, and how to create your own.
|-
|
|-
| [[Virtual Keys]]
| For use with keyboard related functions
|}

==Additional Information==
*[[MicroMacro License]]
*[[Lua License]]

Window Module

2017-12-08T06:01:18Z

Elverion: /* getFocusHwnd */

== find ==
'''number window.find(string windowName[, string className])'''

Finds a window's HWND based on its title (not case-sensitive), and (optionally) its classname (case-sensitive). 'title' and 'classname' can contain wildcards * and ?.

Returns the first match found. If no match was found, returns nil.

== findList ==
'''table window.findList(string windowName[, string className])'''

Finds a list of windows based on title (not case-sensitive), and (optionally) classname (case-sensitive). 'title' and 'classname' can contain wildcards * and ?.

Returns a table of tables containing: 'hwnd' (number; handle to window), 'name' (string; window title), and 'class' (string; identifier used by its programmer). If no match was found, returns nil.

For example, the return value might look like this:
<source lang="lua">
{
{hwnd = 1234, name = "Window Name 1", class = "Window Class 1"},
{hwnd = 5678, name = "Window Name 2", class = "Window Class 2"},
{hwnd = 9012, name = "Window Name 3", class = "Window Class 3"},
}
</source>

== getParent ==
'''number window.getParent(number hwnd)'''

Returns a window's parent, or nil on error.

== getTitle ==
'''string window.getTitle(number hwnd)'''

Returns a window's title as a string.

== setTitle ==
'''window.setTitle(number hwnd, string title)'''

Change a window's title.

== getClassName ==
'''string window.getClassName(number hwnd)'''

Returns a window's class name as a string.

== valid ==
'''boolean window.valid(number hwnd)'''

Returns true if 'hwnd' is a valid window handle, or false otherwise.

== getRect ==
'''number x, number y, number w, number h window.getRect(number hwnd)'''

Returns the position (x,y) and size (w,h) of a window.

== setRect ==
'''window.setRect(number hwnd, number x, number y, number w, number h)'''

Change the position and size of a window with handle 'hwnd'.

== getClientRect ==
'''number x, number y, number w, number h window.getClientRect(number hwnd)'''

Returns the position and size of a window's client area.

== setClientRect ==
'''window.setClientRect(number hwnd, number x, number y, number w, number h)'''

Change the position and size of a window's client area with handle 'hwnd'.

== show ==
'''window.show(number hwnd, number cmd)'''

Show/hide/minimize/maximize/whatever with the window.

For 'cmd', you should specify one of the following constants:

SW_FORCEMINIMIZE

SW_HIDE

SW_MAXIMIZE

SW_MINIMIZE

SW_RESTORE

SW_SHOW

SW_SHOWDEFAULT

SW_SHOWMAXIMIZED

SW_SHOWMINIMIZED

SW_SHOWMINNOACTIVATE

SW_SHOWNA

SW_SHOWNOACTIVATE

SW_SHOWNORMAL

== flash ==
'''window.flash(number hwnd, number flashCount)'''

"Flash" the window to attempt to grab the user's attention.
If 'flashCount' is < 0, stop flashing
If 'flashCount' is 0, flash until user focuses the window
If 'flashCount' is > 0, flash this many times

== getPixel ==
'''number r, number g, number b window.getPixel(number hwnd, number x, number y)'''

Get the color of a pixel at (x,y) inside window 'hwnd', and return the color split into red, green, and blue channels.
r, g, and b results will be between 0 and 255.

== pixelSearch ==
'''number x, number y window.pixelSearch(number hwnd, number r, number g, number b, number x1, number y1, number x2, number y2[, number accuracy[, number step]])'''

Search the given window for a pixel that matches r,g,b within the rectangle outlined by (x1,y1) -> (x2,y2)
The rect may go from left-to-right, right-to-left, top-to-bottom, bottom-to-top, or any combination of those, depending on the orientation of the two points.

'accuracy' is how many units each channel must be within the given color to generate a match. ie. with an accuracy of 20, the red, green, and blue channels must be within 20 of the target color to match. Default: 1

'step' is the step size (distance between pixels to search). You generally have no need for this so long as you aren't scanning a large area, but you may experience faster scan times (with a chance of missing a match) with a higher step size. Default: 1

If the pixel is not found, this function returns nil.

== saveScreenshot ==
'''window.saveScreenshot(number hwnd, string filename)'''

Save a screenshot of window 'hwnd' to 'filename'. If 'hwnd' is 0, this screenshots the whole desktop.
NOTE: You ''cannot'' take a screenshot of a minimized window. This is a limitation in Windows.

== getAppHwnd ==
'''number window.getAppHwnd()'''

Returns the calling process' (MicroMacro) handle to window (HWND). This is what you may use to access or modify the console's properties where an hwnd is required.

== getFocusHwnd ==
'''number window.getFocusHwnd()'''

Returns the hwnd of whichever window is top-most as of the the start of this logic cycle. This is polled once per frame and should be fairly accurate so long as your script executes each logic cycle quickly. Be aware that as windows are being minimized, maximized, or otherwise, the focused hwnd may temporarily switch to NULL (0).

== makeColor ==
'''number window.makeColor(number red, number green, number blue)'''

This helper function converts red-green-blue components into a long integer color value for use in other functions. All input values (red, green, and blue) should be integers between 0 and 255. (0, 0, 0) would result in black, (255, 255, 255) would result in white and (0, 255, 0) would result in green.

== drawLine ==
'''boolean window.drawLine(number hwnd, number x1, number y1, number x2, number y2[, number color[, number thickness]])'''

Draws a line in the client region of the window specied by hwnd (note: use 0 to draw directly to screen). It is possible to draw outside of the given window with this function. A line will be drawn starting from (x1,y1) to (x2,y2) with the given color and line thickness. By default, color will be black (0, 0, 0) and thickness (in pixels) will be 1.

You should use [[Window_Module#makeColor|window.makeColor]]() to generate the number passed as the color value if you wish to specify a color by RGB. Alternatively, you can pass the value in by hex notation (ie, 0xFF00FF).

<source lang="lua">
-- Draw a red line from (0,0) to (200, 200) that is 5 pixels thick on the window.
window.drawLine(hwnd, 0, 0, 200, 200, window.makeColor(255, 0, 0), 5);

-- Draw a green line from (200, 200) to (400, 400) that is 1 pixels thick
window.drawLine(hwnd, 200, 200, 400, 400, 0x00FF00);
</source>

== drawRect ==
'''boolean window.drawRect(number hwnd, number x1, number y1, number x2, number y2[, number color[, number thickness]])'''

This functions exactly like [[Window_Module#drawLine|window.drawLine]](), except that it draws a rectangle rather than a line.

Draws a line in the client region of the window specied by hwnd (note: use 0 to draw directly to screen). It is possible to draw outside of the given window with this function. A rectangle will be drawn starting from (x1,y1) to (x2,y2) with the given color and line thickness. By default, color will be black (0, 0, 0) and border thickness (in pixels) will be 1.

You should use [[Window_Module#makeColor|window.makeColor]]() to generate the number passed as the color value if you wish to specify a color by RGB. Alternatively, you can pass the value in by hex notation (ie, 0xFF00FF).

2016-08-19T05:07:04Z

Elverion: /* Cache:remember */

= Creating a cache instance =
The cache library is optional and must be used by requiring the module. Next, the cache class must be instantiated:
<source lang="lua">
require('cache/cache');

cache = Cache();
</source>

= Drivers =
Various drivers may be used which determine how cached data will be handled. Each driver may have its own set of pros and cons. For instance the 'memory' driver should give great speed, but may consume a lot of memory, will not be saved to disk (the data disappears once the script terminates), and will not share data between instances. By default, the DB driver is used.

== DB Driver ==
This will use SQLite internally to handle data. It should give good speed, but the primary benefit is that it will continually save to disk and all data will be shared across multiple instances. Using this driver will result in data being saved to 'cache.db' in the executing script's directory. You can explicitly create an instance of the DB driver by instantiating with the 'db' driver name:
<source lang="lua">
cache = Cache('db');
</source>

== Memory Driver ==
This will store cached data directly into the Lua engine's memory space. Speed should be great, but storing lots of cached data will require more memory. Cached information should be considered volatile; any cached data will be immediately lost as soon as the script terminates. Additionally, multiple instances of your script will not share data between them. You can explicitly create an instance of the memory driver by instantiating with the 'memory' driver name:
<source lang="lua">
cache = Cache('memory');
</source>

= Example usage =
<source lang="lua">
require('cache/cache');

function macro.init()
cache = Cache(); -- Use the default cache driver
end

function macro.main()
-- Returns the existing value, or generates and returns a new one
local value = cache:remember('testValue', 1, function() return string.random('alnum', 16) end);

print("Cached value:", value);
end
</source>

= Supported methods =

== Cache:driverName ==
'''string Cache:driverName()'''

Returns the 'name' of a driver for descriptive use only.

== Cache:get ==
'''value Cache:get(string itemName, defaultValue)'''

Returns a value from the cache if the item exists and is not expired, otherwise returns defaultValue or nil. In most cases you will probably want to either grab a cached value or set and return a new value, and so it is recommended to use [[Cache_Library#Cache:remember|Cache:remember()]] instead.

== Cache:has ==
'''boolean Cache:has(string itemName)'''

Returns true if an item exists and is not expired, otherwise returns false.

== Cache:set ==
'''Cache:set(string itemName, value, minutes)'''
'''Cache:set(string itemName, value)'''

Sets an item in the cache that will expire in the number of minutes denoted by 'minutes'. If 'minutes' is not given, a value of 1 is assumed. If the item should never expire, pass a negative number for 'minutes.'

== Cache:remember ==
'''value Cache:remember(string itemName, number minutes, function callback)'''

If the item exists and is not expired, the cached value is returned. Otherwise, the callback function will be called (which should return the value you want to be set) and used as the item's new value which expires in 'minutes' from now; again a negative 'minutes' value indicates it should never expire (or use [[Cache_Library#Cache:rememberForever|Cache:rememberForever()]]). If the callback is used to generate a new value, that value is the one returned by this function.

== Cache:rememberForever ==
'''Cache:rememberForever(string itemName, function callback)'''

Exactly like Cache:remember(), only the item is set to never expire.

== Cache:forget ==
'''Cache:forget(string itemName)'''

Removes an item from the cache, regardless of whether it is still valid, expired, or set to never expire.

== Cache:flush ==
'''Cache:flush()'''

Removes all items from the cache.