Program: X3 Logitech G15 LCD Stats Applet
Author: Cycrow
Version: V1.40
===================================================

===================================================
Installing:
* Download latest program
* Kill the original process before installing. (only if you have an older version)
- End the process "X3LCD.exe" from the task manager
* Run the installation Program, X3LCD_Setup.exe
* Install the script package, Logitech_scripts.spk using the Script Manager
- Script Manager avaialble from (www.xpluginmanager.co.uk)
* Goto the Logitech LCD control Panel and configure the applet (see below)
===================================================
First Screen:
[ external image ]
Stats Screens:
[ external image ]
[ external image ]
Ship/Target Screens:
[ external image ]
[ external image ]
===================================================
This is a program that links with the LCD display on the logitech G15 keyboards.
The applet will be registered with Logitech software when its first installed or ran.
Make sure you have the latest version of the Logitech drivers, otherwise it might not run.
Before it will work, you need to set the correct X3 Directory, you do this by going into the Logitech LCD Control panel.
Select the X3 Reunion applet then go to config.
There are 2 options, the x3 file and the log file name.
The logfile name should be fine as the default unless you wish to edit the scripts to change it.
Once its configured, you need to installed the supplied script pack, logitech_scripts.spk
You use the Script Manager to install these scripts and it works as an AL Plugin and can be enable or disabled in game via the AL Settings menu.
===================================================
There are multiple pages of stats available, you use the 4 control buttons on the LCD to change them.
Each button can have multiple pages, so pushing the button multiple times will cycle between the pages.
Button 1:
This is the main stats button, will display 2 pages of stats, include the ships you have, number of stations, game time and credits.
In the top left corner, you will find a display of the amount of salvage insurance you currently have
Button 2:
This is the Combat menu, there are currently 2 pages of display.
The first page is your ships stats, and will display your ship and its hull, shields and weapon energy.
The second page is your targets stats, and displays the speed as well as its Hull and shield strength.
There will also be the number of missiles and enemies in sector displayed if you have the "Combat Computer" installed on your current ship.
The combat computer is an upgrade you can buy from argon and split equipment docks.
Button 3:
This is the race notority and ranks page, will display the current rankings with each race and your combat and trade ranks.
Button 4:
This is the custom stats page, this is used to allow other scripts to display stats to the LCD. Press the button to flick between the pages.
===================================================
Custom Stats (For Scripters):
There are 2 scripts provided in the package to allow you to access to custom stats menu for the LCD.
The "plugin.logitechg15.setcustom" script is used to set the string to be displayed.
It takes 3 arguments, the first is a unique identifier, so you can change and remove the stats at any time.
The second is the string to be displayed, what ever is here will be displayed on one of the slots on the LCD.
The final argument is the expire time, This allows the LCD to automatically remove the stats after a set time.
Setting this to 0 will make it permanant until you manually remove it.
The 2nd script is "plugin.logitechg15.removecustom"
This is used to remove the stats that you previously added. It takes one argument which is the unique identifer you set when seting the stats.
To change the stats, just use the setcustom script agian using the same identifier and the expiretime and stats display will change to what ever you specify
===================================================
Custom Programmable Popup Display:
You can create a script to display what ever you like on the LCD as a temporary popup.
To create the popup, you first need to create the external script, which is a basic text file format.
The script describes how the screen should look, you can add icons and text to the screen and also move them around.
Once the script is created, you then need to display it, you do this using X3 scripts, theres a script supplied in the package called "plugin.logitechg15.display"
This script takes 2 arguments, the first is the filename to your external script, the 2nd is the data array for any varibles. Calling the script
will cause the screen to immediatly for a set time, the time it display for is set in the lcd script file.
LCD Script File:
This is the script file used to create your custom display.
Display Time:
the command, Displayfor:, is used to set the time to display the screen for, after this time, the lcd will return to the standard stats. The time
is in cycles, each cycle is equal to 100ms.
Varibles:
The varible command is used to set all the varibles, each one is matched with the data array passed to the script. Ie the first on the LCD script will
be replaced with the first element in the varible array. To use a varible in the text, you append a $ infront of the varible name.
IE, Varible: myvarible
then in a text line, you add, $myvarible
Icons:
You can add icons to the display, these will be converted to greyscale images.
Usage, Icon: <x> <y> <sizex> <sizey> <filename>
X and y is the position to display on the lcd display
Sizex and sizey is the size of the icon, ie 32x32.
filename is the relative filename of the ico file, ie it will search for the icon file in the same directory the script is run from.
Text:
You can add text to the display, there are 3 sizes to add, Small, Medium and Large. The command is Text, followed by the size, ie TextSmall:
Appending "Scroll" to the end makes the text scroll if its too long to fit on the display, ie TextSmallScroll:
Usage, Text<size>: <x> <y> <length> <align> <text>
x and y is the position on the LCD
Length is the maximum length of the text to display in pixels.
Align is the alignment of the text, either LEFT, RIGHT or CENTER.
Text is the text string to display, can contain the varibles.
Move:
You can use the move command to move any object to a set position in a given time
Usage, Move: <x> <y> <time>
<x> and <y> is the position to move to on the LCD, you can set them to "-" to make it the same as the origina position.
ie, if an object is at 10,20. and you set move to -,30. It will move to 10,30.
The <time> is the time in cycles it takes to move from the start to the end.
Both text and icons can be moved. The move command relates to the object created immeditially before it
MoveRepeat:
Same as the move command, but will repeat the move, ie when it gets to the end it starts over instead of just stopping.
Example:
There is an example available, which display a promotion popup for the guild scripts. The files included are, the main LCD script file, guildpromotion.lcd
the icon to display, up.ico and in the X3 script package, example.lcd.display, which is the script that calls the display. Running this script ill cause it
to display on the LCD so you can see how it works.
===================================================
Future:
* Adding more stats for the Combat Computer
* Adding custom Programmable Popup Stats, can create a stats view that pops up for a limited time overriding current display. Ie for receiving messages.
===================================================
Change Log:
V1.30
* Fixed Target display
* Fixed displaying of negative ships
* Added Custom programmable popup displays
* Added Salvage Insurance Display
V1.20
* Added Combat computer
* Added missile and enemy numbers for Combat Computer
* Added Combat and Trade Ranks
* Added Display of Police licences
* Added Search for stats screen
* Added Custom Stats display
* Fixed close button on configuration Dialog
V1.10
* Added Multiple Pages of Stats
* Added no game screen
* Added stats for each ship type
* Added Combat display
* Added Race Notority Display