
jfyeNG - a Newtek LightWave scene player
Copyright (C) 1998-2003  Arnaud STORQ a.k.a. No Recess/CONDENSE (norecess@planet-d.net)

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.


This document contain the following sections :

 presentation
 platforms
 newtek lightwave compatibility
 constraints & general rules
 newtek lightwave content directory
 texture scrolling
 archive management
 precaching
 replaying
 snapshot
 package
 credits
 contributors
 license
 contact & website
 
All users of jfyeNG should read this documentation before any use.
 

PRESENTATION

jfyeNG allows to render scenes and objects created using LightWave 6.X and 7.X
from Newtek (visit www.newtek.com for more informations about).


PLATFORMS

jfyeNG works on every Win32 platforms (95/98/Me/NT4/2000/XP) (OpenGL, Software) 
and Sony PlayStation 2 (EE-GS only, very few VU use).
Its architecture is robust, modulable and portable.


NEWTEK LIGHTWAVE COMPATIBILITY

Don't forget that jfyeNG is designed to render real-time scenes.
So don't make use of advanced features of LightWave.

Here is a list a supported features :

SCENE
 objects
  motion
  dissolve
  parent
  null
  deformation
  morph mixer (endomorph)
  pivot point
 lights (hardware accelerated versions only)
  distant ONLY
  intensity
  motion
  color
 camera
  motion
  parent
  zoom factor
 scene
  size
  backdrop color
  
OBJECT
 n-surfaces
  scrolling
  gouraud*
  mapping*
   planar
   UV
   cubic
   cylindrical
   spherical
   environment (faked)
  additive*
  double-sided
 n-edges

IMAGE
 JPG
 TGA
  8,16,24,32 bits (raw, packed)
 
*=can be combined. Ex: both gouraud+planar mapping for a surface.


CONSTRAINTS & GENERAL RULES

Only use planar or UV mapping if you want to use mapping.
Morphing works only with Planar and Environment mapped objects.
Do not combine UV mapping and endomorph.
You can only use textures in JPG and TGA formats.
An object can't have multiple layers.
PS2 and Software version do not manage lights.
You can use Size and Center parameters when texturing.


NEWTEK LIGHTWAVE CONTENT DIRECTORY (Windows only)

Pushing the "set LW path" button on the user interface allow to set
the Content directory, working exactly like Newtek LightWave does.


TEXTURE SCROLLING

jfyeNG can manage up scrolling (SCUP), down scrolling (SCDN), 
left scrolling (SCLT) and right scrolling (SCRT).
In order to use this feature, name your texture with the keyword SCUP
inside (for up scrolling). Example: TEXTURE_SCUP.TGA


ARCHIVE MANAGEMENT

jfyeNG can manage full path (Ex: "C:\LW\LWS\SCENE.LWS") or browse
files from an archive file ("filename.JNG").

It consists to link scenes into a one-and-only compressed .JNG file.
This way is safer to distribute your work, because the user does not have 
to use the scenes with their local path.

You can create archive files using jfyeNGArchiver.


PRECACHING

jfyeNG can improve frame-rate performances when rendering a scene 
by using precaching. It allows to display only what is necessary 
(Ex: if an object is recovered by an another one, it won't be displayed).
It produces a .PRK file located into the same directory than the scene file
(Ex: "C:\LW\LWS\SCENE.PRK").

You can create .PRK precaching files using jfyeNGPrecacher.


REPLAYING (Windows only)

"Space bar" allow to skip the current scene to the next one.
When the end of a scene is reached, then the next one is replayed.
When there are no more scenes to replay, the playlist restart
from the beginning.

"L" key allow to switch to Lines mode.

"S" key allow to make a snapshot (see next section).

If a scene has failed while loading, then a red empty screen will be displayed
instead of replaying it.


SNAPSHOT (Windows only)

The "S" key allow to save snapshot of the current replayed scene ;
"jfyeNG.TGA" will be created into the current directory of jfyeNG.


PACKAGE

jfyeNG package contain the executable of jfyeNG (Windows
and Sony PlayStation 2 platforms), jfyeNGArchiver (Windows only), 
jfyeNGPrecacher (Windows only) and this documentation.


CREDITS

All code by Arnaud STORQ (http://norecess.planet-d.net)
"LWSINTERP.C" file based on implementation of Ernie Wright (http://www.newtek.com)
JpegLib (IJG JPEG LIBRARY) (ftp://ftp.uu.net/graphics/jpeg)
FMOD (Firelight Technologies) (http://www.fmod.org)


CONTRIBUTORS

Win32 splash-screen and icons by Yoyo (yoyo@planet-d.net)
Makefile help, Linux port by Jylam (jylam@lnxscene.org)
beta-testing by Med (medcg@hotmail.com)
beta-testing by f0st (f0st@f0st.org)
beta-testing by Yoz, LightWave test-scenes (ANDRE.Jose@wanadoo.fr)
LightWave test-scenes by Xbarr
LightWave test-scenes by Fraa


LICENSE

jfyeNG is free software, shipped under the GPL license.
Please see GPL.TXT for more informations about!


CONTACT & WEBSITE

Arnaud STORQ at norecess@planet-d.net
Visit http://norecess.planet-d.net
