From 600ab7911460ba173f82c78145fe573808d16f89 Mon Sep 17 00:00:00 2001 From: Stijn Buys <ingar@osirion.org> Date: Mon, 24 Mar 2008 16:20:43 +0000 Subject: Documentation update --- README | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) (limited to 'README') diff --git a/README b/README index 6a88cca..b16d74b 100644 --- a/README +++ b/README @@ -97,6 +97,9 @@ Organization of the distribution C++ source code /src + README this file + INSTALL documentation in installation + MODELS documentation on creating models /math mathematical classes /sys low-level system functions @@ -117,6 +120,7 @@ Organization of the distribution /satellites sattelites /ships spaceships /stations space stations + scripts gtkradiant shader files /textures textures /gtkradiant gtkradiant support files @@ -136,24 +140,9 @@ Editing game data there will get precedence over the corresponding file in the game data directory. -Adding models - The models are basic Quake2 style .map files with custom entities - and can be created with a program like gtkradiant. No map compiler is - necessary, the engine reads the .map files directly. Refer to the file - INSTALL on how to install the support files for gtkradiant 1.5.0. - - The textures in the textures/colors/ directory are mapped to RGB colors - when the models are loaded, any real texturing information is ignored. - Unknown textures will be colored hot pink in-game. - - Two special textures are supported: any brush faces textures with - common/caulk will be ignored by the engine, similar to the caulk - feature in quake-like engines. Brush faces with the common/entity - texture will get the current game entity color. This makes it possible - to use the current player color on ship models. - - Add an info_engine entity to add an engine exhaust to a ship model. + and can be created with a program like gtkradiant. Refer to the + file MODELS for more information on creating 3D models. Notes @@ -183,8 +172,7 @@ Acknowledgements This project could not have been possible without the work of others: - Id Software, for releasing the quake source code, which obviously - acted as a example. + Id Software, for releasing the quake source code Id Software and the GtkRadiant project contributers @@ -200,8 +188,22 @@ Acknowledgements License - The program is distributed under the terms and conditions of the - GNU General Public License version 2. + The Osirion Project is distributed under + the terms and conditions of + the GNU General Public License version 2. + + This includes the source code, project documentation and game data. Copyright 2007-2008 Ingar=KCT= <ingar@telenet.be> + + Contact me if you want to use (portions of) this project + under a non-compatible, but otherwise free, licence. + +Trademarks + + QUAKE and ID are registered trademarks of Id Software, Inc. + LEGO is a reigstered trademark of the LEGO Group. + + The Osirion Project is an independent not-for-profit project + and has no affiliation with these corporations. -- cgit v1.2.3