jpt-archive/zengine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

documentation updates

Browse Source
This commit is contained in:
James Turk 2003-12-31 12:59:36 +00:00
parent aebd48414a
commit 53f82f7337
7 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
authors.txt
View File

@ -1,10 +1,6 @@
Listed are the authors of actual ZEngine code, these authors make no claim to Listed are contributors to ZEngine: (Contributions are always welcome)
have written any of the SDL dependencies nor code in the external or zlib
directories.
James Turk james@conceptofzero.net - Core Engine, Design, Docs, and Classes James Turk james@conceptofzero.net - Core Engine, Design, Docs, and Classes
Gamer Tazar tazar@conceptofzero.net - OpenGL assistance
Sean sean@conceptofzero.net - MSVC++6 Project Files
Kevin Watters kwatters@adelphia.net - Fix to ZImage::SetColorKey Kevin Watters kwatters@adelphia.net - Fix to ZImage::SetColorKey
Atani atani@atani-software.net - Revised Linux Build System Atani atani@atani-software.net - Revised Linux Build System
Stinus Petersen (bison@flytlet.dk) - Fix for ZImage::OpenFromImage with alpha images Stinus Petersen (bison@flytlet.dk) - Fix for ZImage::OpenFromImage with alpha images

12
changelog.txt
View File

@ -1,5 +1,5 @@
ZEngine Version Log for Version 0.8.5 ZEngine Version Log for Version 0.8.5
$Id: changelog.txt,v 1.60 2003/12/24 04:42:43 cozman Exp $ $Id: changelog.txt,v 1.61 2003/12/31 12:59:36 cozman Exp $
Changes are marked with symbols that describe them: Changes are marked with symbols that describe them:
! is code that breaks backwards compatibility (used after 0.8.0-rc1, previous versions broke compatibility) ! is code that breaks backwards compatibility (used after 0.8.0-rc1, previous versions broke compatibility)
@ -10,15 +10,19 @@ Changes are marked with symbols that describe them:
(Note: Depreciated code (that marked with a *) is likely to disappear completely at the next major version.) (Note: Depreciated code (that marked with a *) is likely to disappear completely at the next major version.)
0.8.6 0.9.0
! Removed SetupDisplay/SetupSound and integrated them into CreateDisplay. ! Removed SetupDisplay/SetupSound and integrated them into CreateDisplay.
! Changed error system functions drastically. ! Changed error system functions drastically.
* Depreciated (useless) SetDesiredFramerate and related functionality. ! Removed (useless) SetDesiredFramerate and related functionality.
+ Added severity option to error reporting for better error logs. ! Removed all "depreciated" code.
! Removed Doxygen documentation comments.
! Changed several member functions with obsolete names.
+ Introduced severity option to error reporting for better error logs.
+ Added HTML output option to error system. + Added HTML output option to error system.
+ Added XML resource file support via TinyXML (ZEngine::SetResourceFile, ZEngine::GetStringResource, etc) + Added XML resource file support via TinyXML (ZEngine::SetResourceFile, ZEngine::GetStringResource, etc)
+ Added ZAnimation class. + Added ZAnimation class.
+ Added ZAnimTest, test of ZAnimation. + Added ZAnimTest, test of ZAnimation.
# Reworked small internal portions of API.
# Changed several tests to support new resource file support. # Changed several tests to support new resource file support.
# Turned off warnings for zlib files in VC7 and DevC++. # Turned off warnings for zlib files in VC7 and DevC++.
# Switched to updated zlib 1.2.1. # Switched to updated zlib 1.2.1.

7
licensing-template.txt
View File

@ -4,9 +4,12 @@ Licensing Information for ##PRODUCT##:
This application makes use of ZEngine which is available from http://zengine.sourceforge.net/ and is licensed under a BSD-style license. This application makes use of ZEngine which is available from http://zengine.sourceforge.net/ and is licensed under a BSD-style license.
ZEngine uses the following for reading from archives: ZEngine uses several libraries under the zlib license (http://www.gzip.org/zlib/zlib_license.html):
Unzip and zlib for reading from archives:
Gilles Vollant's unzip - http://www.winimage.com/zLibDll/unzip.html Gilles Vollant's unzip - http://www.winimage.com/zLibDll/unzip.html
zlib - http://www.gzip.org/zlib/ - http://www.gzip.org/zlib/zlib_license.html zlib - http://www.gzip.org/zlib/
TinyXML to parse XML resource files:
http://tinyxml.sourceforge.net/
ZEngine uses the following LGPL (see lgpl.txt) libraries: ZEngine uses the following LGPL (see lgpl.txt) libraries:
SDL - http://libsdl.org SDL - http://libsdl.org

6
licensing.txt
View File

@ -4,7 +4,7 @@ more info.
A Note From James: A Note From James:
I chose to license ZEngine under the most liberal license I could find for I chose to license ZEngine under the most liberal license I could find for
a number of reasons. I really didn't want to think that anybody would steal all a number of reasons. I really didn't want to think that anybody would steal
the work put into this and call it their own, and the person that does would do the work put into this and call it their own, and the person that does would do
that even if it were under a more restrictive license. I would like to know that even if it were under a more restrictive license. I would like to know
where ZEngine is being used, but I'm not going to require it and I'd also like where ZEngine is being used, but I'm not going to require it and I'd also like
@ -27,7 +27,7 @@ point without concern.
----------------------------------(begin license) ----------------------------------(begin license)
Copyright (C) 2002, 2003 James Turk Copyright (C) 2002-2004 James Turk
All rights reserved. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, Redistribution and use in source and binary forms, with or without modification,
@ -60,7 +60,7 @@ the following notice:
/******************************************************************************* /*******************************************************************************
This file is Part of the ZEngine Library for 2D game development. This file is Part of the ZEngine Library for 2D game development.
Copyright (C) 2002, 2003 James Turk Copyright (C) 2002-2004 James Turk
Licensed under a BSD-style license. Licensed under a BSD-style license.

4
readme.txt
View File

@ -9,8 +9,8 @@ VI. History of ZEngine
------------------------------------------------------------ ------------------------------------------------------------
I. About ZEngine 0.8 I. About ZEngine 0.8
ZEngine is a game library which is designed for any platform that SDL and/or ZEngine is a game library which is designed for any platform that SDL and
OpenGL is available on. ZEngine is a set of classes and a main ZEngine class OpenGL are available on. ZEngine is a set of classes and a main ZEngine class
which are designed to make game development easier and more organized. As of which are designed to make game development easier and more organized. As of
0.7.7 ZEngine can use OpenGL to do the 2D display, so it is much faster and can 0.7.7 ZEngine can use OpenGL to do the 2D display, so it is much faster and can
take advantage of hardware accelerated features. This file provides a simple take advantage of hardware accelerated features. This file provides a simple

4
thanks.txt
View File

@ -5,7 +5,7 @@ Sam Lantinga and the SDL Crew - Creating and Maintaining such a great library an
Dimitri van Heesch and Everyone Associated with Doxygen - Providing such a great Documentation Tool. Dimitri van Heesch and Everyone Associated with Doxygen - Providing such a great Documentation Tool.
http://doxygen.org http://doxygen.org
Everybody Associated with ConceptOfZero.net - Keeping Me Working on ZEngine. Everybody Associated with ConceptOfZero.net - Keeping Me Working on ZEngine.
http://conceptofzero.net http://conceptofzero.net (Sean for his VC6 support and Tazar for his OpenGL support)
The people at the Kahvi Collective - Providing tons of free Ogg music. The people at the Kahvi Collective - Providing tons of free Ogg music.
http://www.kahvi.org http://www.kahvi.org
Sourceforge.net - Providing hosting for the project and CVS. Sourceforge.net - Providing hosting for the project and CVS.
@ -22,5 +22,7 @@ Authors of zlib for making a great library, and making it free and open source.
http://www.gzip.org/zlib/ http://www.gzip.org/zlib/
Gilles Volant for making Unzip, making zlib so easy to use. Gilles Volant for making Unzip, making zlib so easy to use.
http://www.winimage.com/zLibDll/unzip.html http://www.winimage.com/zLibDll/unzip.html
Lee Thomason and others involved in TinyXML for a simple XML parser.
http://tinyxml.sourceforge.net/
Also see the test/bin/readme.txt file for credits on the data used in the demos. Also see the test/bin/readme.txt file for credits on the data used in the demos.

3
todo.txt
View File

@ -1,10 +1,9 @@
ZEngine Todo List ZEngine Todo List
-NaturalDoc documentation
-'ZDisplayList' class or similar solution. -'ZDisplayList' class or similar solution.
-Add Support for ZLib in ZMusic. (Waiting on SDL_mixer.) -Add Support for ZLib in ZMusic. (Waiting on SDL_mixer.)
-ZSprite class -ZSprite class
-ZResourceFile class
-Entirely New ZFont class, using display lists (possible) -Entirely New ZFont class, using display lists (possible)
-OSX support
-Lua Scripting Integration -Lua Scripting Integration
Things to add outside ZEngine: Things to add outside ZEngine: