Program XBLAST V2.0 
1993-1996 (C) by Oliver Vogel (e-mail: vogel@ikp.uni-koeln.de)

"Level Edit Tools"
May 14th, 1996

File: etc/README

LICENSE

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

This program is distributed in the hope that it will be entertaining,
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.
675 Mass Ave, Cambridge, MA 02139, USA.

AUTHOR

Oliver Vogel 
vogel@ikp.uni-koeln.de


FILES

o  README	- this file
o  TODO         - what is still to be done
o  addBitmap    - tcl script file to add bitmap to xblast
o  addLevel     - tcl script file to add level to xblast
o  convertLevel - tcl script file to convert level form 1.2 to 2.0
o  removeLevel  - link to addLevel

DESCRIPTION

This file is a short description of the tools in this
directory.  All tools should be started from the xblast
main directory.  You will need TCL to run all script
mentoined here.  It should run with TCL 7.3 as well as with
TCL 7.4.  The following scripts are available

+ addBitmap 
	adds a bitmap to your xblast source files. You will
	need one (or two) bitmap in the xbm format. 

	Usage:
	$ etc/addBitmap blockName bitmapFile [addonFile]

	- blockName is the name of the C constant to be
	  used in the level data files. It must look like
	  "BL..."
	- bitmapFile is name of the XBitmap file containing
	  the graphics. You can use the program "bitmap" to 
	  create an .xbm file. It must have a width of 64
	  pixels and a height of 48 pixels. Be sure the
	  name of constants and data array corresponds is
	  based on the filename.  It should be located
	  in "XBlast-2.0/bitmap/color/block"
	
	You can always modify the .xbm files afterwards.
	The changes will take effect , as soon as "block.c"
	is rebuild.

	addBitmap will modify all necessary files of the
	XBlast 2.0 source package, i.e. "block.c" and
	"block.h".

+ removeBitmap
	SORRY! NOT FINISHED YET. :(

+ addLevel
	adds level data file to your xblast sources. The
        level data file should be in the directory
	"XBlast-2.0/level"

	Usage:
	$ etc/addLevel levelFile

	- levelFile is the name of level data file

	addLevel will modify all necessary files of the
	XBlast 2.0 source package, i.e. "data.c" and
	"include.h"

+ removeLevel
	removes a level from your xblast sources. It does
	NOT delete the acutal level data file. It only
	removes any reference to the level form your
	XBlast sources.

	Usage:
	$ removeLevel levelFile

	- levelFile name of the level file to be removed
	form the sources

	removeLevel will modify all necessary files of the
	XBlast 2.0 source package, i.e. "data.c" and
	"include.h"

+ convertLevel
	converts a level from XBlast 1.2 format to a level
	file for XBlast 2.0. It will extract the level data
	from old style "data.h" file and write it into
	level include file for XBlast in "XBlast-2.0/level"

	Usage:
	$ etc/convertLevel dataFile levelName

	- dataFile is name of the XBlast 1.2 style data.h file
	  to extract your level from

	- levelName is the name of the level to be
	extracted.

	If no level name is given, convertLevel lists all
	the levels in the given dataFile.
	Otherwise convertLevel will extract the level
	named levelName and write the converted data
	intro the file level/"levelName".h
	Don't forget to call addLevel afterwards.

BUGS

convertLevel will ignore emtpy lines and full line C-comments in the
level definition, but will produce garbage when C-comments
are in the same line as a data defintion.

addBitmap does not check the consistency of the bitmap. Furthermore it
assumes that the prefix for the bitmap data and constants is the
basename of the .xbm file, e.g if your file is foobar.xbm the data
array is foobar_bits. Most program save .xbm files this way.
You may get intro trouble when using a filter like pbmtoxbm.

addLevel does not peform a syntax check for the level data file.

