   Luxinia 
=====================
http://www.luxinia.de

The project is still in development so not all might work as it should.
Please give us your feedback at www.luxinia.de


Installation
------------

If the application (any .exe) fails to load, run
vcredist_x86.exe and try again.


Other
-----

We suggest not to run the engine at "full-throttle"
but cap FPS either in the Options menu or in
base/config.lua -> system.maxfps
or if using "full-throttle" (system.maxfps(0)) use VSynch of your
video driver (or rendersystem.swapinterval(1)).
That way you dont stress the CPU so much, and there is no loss
in visual quality.

Authors
-------
Christoph 'CrazyButcher' Kubisch - http://pixeljetstream.luxinia.de
  most engine code, rendering, effects, resources definition and management...
  3dsmax tools, engine tools

Eike 'Zet' Decker - http://www.cube3d.de
  game code, most lua code, gui, physics integration...
  cinema4d tools
  most graphic assets of the demo games


Commandline
-----------
-f or --fullscreen 
  to start in fullscreen

-v ARGS
  to start the resource viewer (or leave ARGS empty)
  ARGS can be:
   MATERIALFILE (.mtl)
   PARTICLEFILE (.prt)
   MODELFILE (.f3d/.mm) Optional followed by ANIMFILE(.ma)
  
  use -p to view resources in your project directory


-p PATH
  to start from a certain project directory
  sets projectpath to PATH and execs PATH/main.lua
  if -v is also an argument then main.lua will not be executed

-s PATH
  to search and start from a project directory
  recursively looks for main.lua in PATH or directories above
  Finally sets this path as projectpath and execs PATH/main.lua
  Only absolute paths are allowed. Useful to automatically
  start a project by passing some subdirectory of it.

  if -v is also an argument then main.lua will not be executed

-d
  creates new helpfiles in /doc/frames

Developer Expert Options
------------------------
-l or --l3dconfig l3dsets;layers;maxlayerdraws;maxtotalprojs
  to set internal configuration for l3dlist
  The last two can be changed at runtime. 
  
  Defaults are: 4;16;16384;8192
  
-m or --memconfig bufferMB;resdefaultMB
  startup memory chunks in MegaBytes.
  Buffer is used for per-frame scratch operations and for
  various load functions. Buffer can be changed at runtime with
  "system.buffermempoolsize()", and it will automatically be 
  increased for screenshot and texture save operations, in case
  it was too small. If the limit is exceeded otherwise, there will
  be a program termination and log entry.
  Resdefault can be deleted once with "reschunk.destroydefault()"
  
  Defaults are: 16;16
  
Controls
--------

F1  - toggle console
ESC - quit

F3  - write JPG
F4  - write TGA
F11 - jpg screenshot every frame (running at capped 30 fps)


luxinia_con.exe
----------------
This executable provides a dosbox with runtime output.

luxinia_cust.exe
-----------------
This executable allows custom frontend bindings via Lua. We
currently default to wxLua (wxWidgets), which allows to
embed luxinia in a wxGL window. This functionality is relatively
untested yet. There is also no support yet for "destroying"
luxinia, once it has been kicked-off in such a window.
Multiple window support is also not (and will never be) supported,
but can be emulated with opengl context sharing.



Development with luxinia
------------------------
The entire game-engine is controlled by lua scripts, all time critical
things are hardcoded in C. For the gamecode however you need to code your
own lua scripts. 

in /doc/frames/index.html are all published functions 
you can access from lua/console

you can access a command with class.method(args)
once you created a class variable you can 
do var:method(args) which is same as class.method(var,args)

For more info see www.luxinia.de


Scripts
-------

All LUA Scripts in the package are released under the MIT license.
http://www.opensource.org/licenses/mit-license.html

Models/Art
----------

All art files (models,textures,sounds,animations) of the projects are created by 
the authors (or otherwise mentioned) and cannot be used without permission.

Releases
--------
04.07.2009: v 1.358 (test)
26.03.2009: v 1.331 (test)
10.12.2008: v 1.301 (test)
29.09.2008: v 1.281 (test)
-- version number 1.Yxx reflects years
-- after first public release 
20.07.2008: v 0.98  (test)
14.09.2007: v 0.97
26.02.2007: v 0.96
22.11.2006: v 0.95
25.08.2006: v 0.94
12.07.2006: v 0.93
26.04.2006: v 0.92
 7.12.2005: v 0.91
 1.12.2005: v 0.9