  															      07/04/2008
                             l
                              ll
                               lll
                               lll
                               lll                          aaaaaaa  a
                               lll        uu     uu        aa    aaaa
                              lll         uu     uu       a       aaa
                              lll         uu     uu                aa
                             lll          uu     uu          aaaa  aa
                            lll            uu    uuu       aaa  aaaaa
                           lll             uuu    uuu     aa      aaa
                            llllllllll      uuuuuuuuu     aa      aaa
                              llllllllll       uuu  uuu    aaa  aa aa
                                     ll               uu     aaa    aa
                                     l                               a



                                   ssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssssss
                                 ssss        t                t
                                sss         tt               tt       ii
                                sss         tttttt  aaa      tttttt           oooo      n  nnnn
                                 sss        tt         a     tt              oo  oo      nnn  nn
                                   sss      tt          a    tt       ii    oo    oo     nn    nn
                                     sss    tt      aaaaa    tt       ii    oo    oo     nn    nn	V 1.3
                                     sss    tt     aa   a    tt       ii    oo    oo     nn    nn
                                   ssss     tt     aa   a    tt       ii     oo  oo      nn    nn
sssssssssssssssssssssssssssssssssssss        ttt    aaaa a    ttt      iii    oooo       n      nnn	par Samy (alias Gogy)


                                                                                                        


                                                                                           English translation and testing by IMIX.

********************************************************************************************************************************************

Foreword:

********************************************************************************************************************************************

First I would like to clarify the following:
This add-on has evolved from Luaprog (v0.2) developed by Novservant (Jrmy) with the help of Sabbator.
A big thank you for his agreement to release its sources (a number of functions described below are the
results of their work).


Secondly, this add-on was created with two objectives:
- Lua-learn,
- Can create entirely on PSP, without having to go through the PC.




********************************************************************************************************************************************

But what exactly is this?

********************************************************************************************************************************************

Lua station is a text editor designed specifically for programming Lua on PSP (itself being developed in Lua).
Moreover, it was attached to Luaplayer to allow for a continuous development on the PSP (which avoids going between homebrews ... 
Not bad to save time and battery).
Note: LuaStation has necessitated the program change of 'Lowser' created by Joachim Bengtsson <joachimb@gmail.com>
(Aka Nevyn)

Here you will find enclosed documentation of the main functions and Luaplayer Lua in the directory "Documentation".
Ideal for carrying everywhere with the documentation itself (just open the document that interests you).




********************************************************************************************************************************************

Safeguards:

********************************************************************************************************************************************

Well precisely there is no guarantee: no I can not be responsible for any damage that may happen to any
PSP system using this program or its derivatives. (And if it does, do not use this program or its derivatives ;-))
Use at your own risk!!




********************************************************************************************************************************************

Installation:

********************************************************************************************************************************************

This requires Luaplayer to be installed first on the PSP.

CHANGE ##### ##### ATTENTION
  As a result of the use of a font other than that included in the interceptor, you must use a Luaplayer
with the different fonts. Currently: the official version, and mods such as HM (recommended for PSP SLIM
Pending an official version) have the necessary fonts.



Attention!  this step is particularly important ;-)
It is necessary to extract the file "Lowser" from the archive file to the Applications directory of your Luaplayer install. 
(Regardless of the file GAME/GAME150/GAME3XX). A window will appear asking for confirmation to replace the files already present.
Simply click on "yes" or "all" (that is less tiring:-p)

And now it's done!




********************************************************************************************************************************************

The use:

********************************************************************************************************************************************

Launch Luaplayer, you find yourself in the classic Lowser shell.
To run a program: press [CROSS] (for all other functions of classic Lowser, consult the help file in the
Luaplayer archive).  Other navigation is apparent in the Lowser window.



Some small changes were added to Lowser:
- Current key controls for navigation.
- Indication of free RAM.
- Rapid scrolling through files when [top]/[down] is pressed.

About the RAM:
 After it is launched, the publisher retains some of the data in ram, (in order to expedite the publishing of other programs).
However, it is possible for the RAM to saturate, and alerts will appear.
Alerts in succession:
- When RAM drops below 8Mb, it is proposed to run the garbage collector to remove certain unused components,
For this press [select] and then move the cursor navigation to update the state of the ram.
- When the RAM has less than 4MB free, it is proposed to restart Lowser. Hold [START] depressed until
An error message appears, Lowser will reboot, and the memory will be cleared.




To edit a program: [square]



Here you are in the editor:
The program that you selected from the shell is open for editing.



The interface:

* At the top left are the headings "File", "Options" and "Help".

* High in the middle are the indicators for Auto-complete and Auto-help.

* A little more right is the state of the battery (in red if the PSP is in charge).

* And more to the right, the line and column of the cursor.

* At the bottom lies the path to the edited file.


Note: an innovation of LuaStation 1.3 is the choice of shortcuts. In what follows, the shortcuts
cited will correspond to the original shortcuts. (There are marked with a #). A later section explains
How to change the shortcuts.




For cursor movement:

* Use the Analog stick for a quick scroll, or tap the directional keys for a specific movement
(Continue pressing, the cursor will scroll quickly).

* To facilitate browsing, you can skip at the end / beginning of the document by pressing:
# [L] + [SQUARE] and [DOWN] / [TOP].

* Similarly it is possible to skip to pageUp/pageDown by pressing: # [L] + [SQUARE] then [RIGHT] / [LEFT].
Note: To skip several successively page without having to repress the key combination, hold  # [L]
And [LEFT] / [RIGHT], and simply press the [SQUARE] key again.

* You can place the cursor at the end or beginning of a line by pressing  # [L] + [SQUARE] then 
[CIRCLE] or [SQUARE].

* To go directly to a certain line: press # [R] + [SQUARE], then enter the line number from the keypad.
Note: To cancel, put the figure 0 and press [R] or press [START].




To enter text:

* Press the [START], the keyboard opens. It uses the DANZEFF keyboard:
(PAD + [SQUARE] / [CIRCLE] / [TRIANGLE] / [CROSS]).
Note: it is possible that the display will move at this time if the cursor is too low: this is to
To ensure better readability of the code when entering text.

* To enter uppercase characters: hold [R].

* To enter the numbers: press [L] (the sign next to the "4" is the tab, the sign next to the "5" is the
Return to the line).

* To access punctuation and special characters press [R] in when you are in the numbers interface.

* To close the keyboard re-press the [START].

* There is a shortcut to delete a character: (TRIANGLE acts as backspace)

* Similarly for adding line: (CROSS acts as enter)




The few useful functions:

* To copy the text: press # [L] + [CIRCLE], the selection mode is activated then. Move the cursor to expand
Your selection, it is then highlighted in red. Once the desired selection is made, hit again
# [L] + [CIRCLE] to copy everything into memory.
Note: During the selection phase, it is always possible to jump from one page using the keys
# [L] + [SQUARE] and the direction buttons.

* The deletion of text as well as for copying, start by press # [L] + [CIRCLE], for your
Selection. Then press [TRIANGLE] to delete the selection. (Attention it is not reversible! Only
Reopening of the file can return to the last backup without taking into account recent changes).


* It is possible to indent single or multiple lines of selected text to the left / right. 
For this press # [R] + [LEFT] or [RIGHT], this shifts the repective lines to the left or right.


* Search text: press # [R] + [CROSS]. Then enter your text using the keyboard. Then tap on the button
[RIGHT] / [LEFT] to find your text toward the end or beginning of the document. To stop the search press [START].
Note 1: It is possible to paste the copied text using the method above, by pressing [SELECT]
Note 2: to alternate the search with or without breaks, press [TOP] or [DOWN]




Headings "File", "Options" and "Help":

* To access the menu, press [L] + [R] while keyboard is not activated. 
A drop-down menu appears, you navigate using the directional keys.

--- --- FILES

* "New": It lets you create a new document. The header contains the date of creation, as well as Your name.
Note 1: Before you create your document, a window opens, asking you whether you want to save the
Current document.
Note 2: To cancel press [L].

* "Open": you can open a file in text format (images display directly) or hexadecimal.
To navigate, use [TOP] / [DOWN] or the analog stick.
To open a directory or file, navigate to the file and press [CROSS] or [R] or [RIGHT] (choose one).
To move up one directory: go to the directory named ".." And pressed [CROSS], or press [LEFT].
To open a file in text mode, simply press [CROSS] when highlighted. If it is an
Image, an overview will be posted. (press [CROSS] or [CIRCLE] or [START] to leave.

To open any file in hexadecimal mode, press [TRIANGLE] when the cursor is over it.
To exit the menu "Open" press [L]
Note 1: before opening another document, a window opens, asking you whether you want to save
The current document.
Note 2: To cancel press [L].

* "Save": allows you to save a file in ASCII format with the desired extension (if the file was opened in
Text format), or hexadecimal format.
Note: The name default is the last open file.
Navigation is just as it is for "open".
To change the name, open the keyboard by pressing [START] and move the cursor to the [LEFT] / [RIGHT].
Save by pressing [R].

To delete a file, place the cursor above, then press [select] + [triangle], a window opens asking you
Confirmation. (Formerly shortcut has been removed as a result of unintentional deletions).

To create a new folder: enter the name of your file, and press [CIRCLE]


* "Exit LuaStation": allows you to return to the shell of Luaplayer.
Note 1: before leaving the editor, a window opens, asking you whether you want to save the
Current document.
Note 2: To cancel press [L].


--- --- OPTIONS

* "Color syntax" Allows you to enable syntax coloring. This makes it easy to read but slightly slows down the
Program (the algorithm has been changing, so it is faster than before)
Note: you may encounter two bugs (not corrected yet):
- If you have a type comment --[[  ]] on one line, the entire line will be colored green! For
Remedy the inconvenience I advise you to skip the line after all.
- Colouring does not take into account the special characters in a citation so that the colour for
The syntax: " \" " will be shown abnormally. To remedy this inconvenience, I advise you
to try the characters in the following way: " \' " or ' \" '

* "Line numbers" displays the line numbers on the left side.

* "Scroll bar" creates a moving bar on the left, indicating the position of the page in the document
(And how large the script is).
Note: To avoid reducing the area of reading, the scroll bar and the numbers of lines cannot
Be displayed at the same time.

* Auto-complete ": This is an input mode that allows you to accelerate the entry of recurring expressions,
the majority of function of Lua, as well as those specific to its integrated LuaPlayer. See more about this
in the section below HELP.

How it works:
When you enter characters, the program looks for a match in the database. The result is displayed
With a small window, where you can navigate using [UP] or [DOWN]. If it matches
An expression of interest, press [select] to insert in your text.
Note 1: thanks to the members of XtreamLua for improvement.
Note 2: not working at the same time as using automatic-help

* "Function help": This mode gives you direct access to the descriptions of the function (if one is listed)
On which the cursor is positioned. A window appears at the bottom of the screen, it includes the function name with its
Arguments, the data returned, as well as a description of the function. To scroll the text
Use [TOP] or [DOWN]. If the start of the entry you entered matches has several functions, they will be
Displayed in a row. (This makes it possible to find the name of a function of which you are not sure of, or to
Assure you of its operation ,...)

* "GUI color"  lets you customize the interface of the editor:
- Parameters of color (Red Green Blue) can be modified using [LEFT] / [RIGHT]
Note: You can change the color of the editor in general as well as text.
- The background: a selection of images are available, or no image (editable using [LEFT] / [RIGHT])
Note: You can make your own pictures, simply put them in the directory img\bg\
- To see the effect press [select]
Note: the color of the text is automatically updated.
- To cancel and return to the old appearance press [L]
- To adopt the new configuration press [CROSS].


HELP --- ---

* "Help": explanations of the functions of the publisher.

* "Credits" for thanks.

* "Init. Self-comp." Allows initialization of an auto-fill: the program parses the script
To include functions to accelerate your text entry.
Note: If your program uses scripts in the same directory as the script edited,
LuaStation will parse those as well.




Shortcuts:
LuaStation 1.3 allows you to choose the shortcuts that you think are the most adequate for the controls.
When in the editor, press [select].  The menu displays when the keyboard is not activated. A "shortcuts" menu appears.
Move the cursor (highlighted in blue) on the lines of shortcuts to change. Press [Select], the line is then
Highlighted in red. Enter a key combination of your choice:
[R] / [L] + [TOP] / [DOWN] / [RIGHT] / [LEFT] / [TRIANGLE] / [SQUARE] / [CROSS] [CIRCLE]
Note: If the shortcuts were to be the same as that of another function, then the two shortcuts will swap.
To leave this menu press [R] / [L].



********************************************************************************************************************************************

The known bugs:

********************************************************************************************************************************************

* Both bugs reported above on the coloration.

If you have more bug please let me know: See below





********************************************************************************************************************************************

To do:

********************************************************************************************************************************************

* Improve the image editor (for sprite and background) and incorporate it into LuaStation

* Finish the description of the functions,

* Add descriptions of some missing features.

Please let me know your suggestions: See below




********************************************************************************************************************************************

Acknowledgments:

********************************************************************************************************************************************

* First Sony for this wonderful console ... Even if it is a pity they do not accept the Developer community more.

* To IMIX for his help: translation into a veritable English, and lots of bug testing! Many thanks.

* To all those who participated in any way to hack the PSP. A tremendous work that benefits
So many people ..

* To all those who have contributed to the development of Luaplayer (especially Shine).

* A Novservant and Sabbator for creating Luaprog.

* To all those who made tutorials on programming on PSP on XtreamLua, PSPGen, PlayerAdvance and Luaplayer.

(Sorry for all those I have not mentioned :-( I do not know your names).

********************************************************************************************************************************************

Contact me:

********************************************************************************************************************************************

If you find unreported bugs, or if you have any suggestions, or if you have comments,
Contact me at "reivax_vet@hotmail.com"