User Manual for the Ca3DE Demo
Contents
1. Nonetheless I specifically created a section Quick Start on page 5 for those who are in a hurry and are experienced with software downloaded from the Internet I hope you ll be happy with the Ca3D Engine I have done my best to create a good product which I will refine on an ongoing basis The only catch is if for any reason you re unhappy with the program you must tell me why you don t like it Otherwise Pll never get it any better 1 1 About this manual This document is a replacement for the old Readme txt and Changes txt files It is written using the IATFX typesetting system and is published in PDF format This way the documentation is easier for me to maintain and more readable and useful to you Throughout the entire document the following conventions will be used e Technical terms that typically appear on your computer screen are written in type writer font e Sometimes I use synonyms for certain terms For example Ca3DE is simply an abbreviation for Ca3D Engine Please refer to the Glossary on page 14 for a clarification of what is what 2 Quick Start 1 2 Windows and Linux specifics The instructions and examples in this manual were written with reference to the Mi crosoft Windows operating system Now with Ca3DE being also available on Linux I rely on the Linux users skills and experience to transfer the provided information to their favourite OS The transfer is almost always very easy to achieve Exa2. is ignored That means that you cannot control the player while the console is active The US keyboard layout applies independently from other settings in the operating system There are several defined console commands and variables but I will only give two examples here help or h prints out a short console help text which should be sufficient if you really want to try out the other commands such as changing the video mode or render style 4 Running Ca3DE Action Key Alternative Arrow up W Move forward Move back Arrow down S Turn left Arrow left Mouse left Turn right Arrow right Mouse right Strafe left A i Strafe right D Jump SPACE Walk R SHIFT L SHIFT Run even faster R_CTRL Look up PAGE UP Mouse up Look down PAGE DOWN Mouse down Look banked CW HOME Look banked CCW INSERT Look straight ahead END Talk Chat Toggle Console 7 Screen shot F5 Quit program ESC Table 1 Keyboard layout for player control and game operations re passwd ca3d re cl lt filename gt rc is the short form for remote console It means that the rest of the line is not processed by the local client but rather sent to the remote server console cl is the short form for change level Therefore the first line introduces you as the super user at the server The second line instructs it to initiate a level world change For quick tests however it is much easier to leave the game with the E
3. is welcome and helps further improvement Internet http www Ca3D Engine de E Mail CarstenFuchs T Online de Postal Carsten Fuchs Feckweilerhaide 6 55765 Birkenfeld Germany A Legal This section contains legal terms and conditions relating to the Ca3D Engine All use of the Program is governed by the terms of the End User License Agreement below You should carefully read the following section before installing this software program If you do not agree with the terms of this section you may not install the software 11 A Legal A 1 End User License Agreement Ownership and License This software program any printed materials any on line or electronic documentation and any and all copies and derivative works of such software program and materials the Program are the copyrighted work of Carsten Fuchs All title ownership rights and intellectual property rights in and to the Program and any and all copies thereof are owned by Carsten Fuchs The Program is licensed although for free not sold Your license confers no title or ownership of the Program The Program is protected by the copyright laws of Germany international copyright treaties and conventions and other laws All rights are reserved Limited Warranty THE PROGRAM IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND EITHER EXPRESS OR IMPLIED INCLUDING WITHOUT LIMITATION THE IM PLIED WARRANTIES OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE OR N
4. s s cecs gossa a dmg da near an a a 4 2 Keyboard Layout s s sra Tmk s ea la ee ar nu en 43 The Command Console 2 2 55 sa kgad ne Known Issues Contact Information Legal A 1 End User License Agreement AA Noes o u ga a nk de a a ae eA ae ee Glossary 11 11 11 12 13 14 1 Introduction 1 Introduction Welcome to the user manual of the latest public test release of Carsten s 3D Engine The Ca3D Engine is a modern 3D graphics engine It is a hobby project which I have developed over a number of years Its most essential features include e high quality real time 3D graphics e cross platform and cross compiler portability e multi player network support e physically correct lighting radiosity based e dynamic per pixel lighting and shadows e 3D sound effects e skeleton based model rendering and e great flexibility and easy extensibility by MODs A more extensive feature list is available on the website at http www Ca3D Engine de The website is the main source of general information for the Ca3D Engine project it has the latest news the latest demo version screen shots and additional information about the project itself This document is the main information source for the specific public test release a k a demo version of the Ca3D Engine from May 2005 I recommend that you read the entire manual as some of the information in it is not mentioned either on the website or anywhere else
5. them 4 Running Ca3DE Ca3D Engine x Welcome In most cases you can leave these settings as they are and just press the OK button For further information or help please refer to the user manual Please select a runmode Client only Server only Both Client and Server for single player mode client joins server on localhost Client options DeathMatch player name Playe Configure DeathMatch model name James o Client port number a0 Remote hostname or IP PE Remote port number eooo Get Sy Into Ping Seren Send NOP Display resolution 1024 768 changeable at the console y Display color depth 32 bpp TrueColor H Texture detail medium faste Server options Game DeathMatch E World name ReNoElixir y Server port number 30000 Status OK Cancel Figure 1 The Ca3D Engine Options Dialog Configure This button does not work yet Later one will be able to configure load and save player profiles here Model name The name of your model This defines what you look like for others in multi player games Client port number The local network port number that this client will use for network communication 4 Running Ca3DE Remote hostname or IP The name or the IP of the server that you wish to con nect to Remote port number The port number at which the server is listening on the remote host Get Server Info Retrieves information from the server such as current world num
6. Ca3D Engine User Manual Carsten Fuchs May 2005 Copyright 1999 2005 Carsten Fuchs All rights reserved This manual and the software described herein is provided under license and may be used or copied only in accordance with the terms of such license The content of this manual is provided for informational use only it is subject to change without notice and should not be construed as any kind of ongoing commitment by Carsten Fuchs I assume no responsibility or take liability for any errors or inaccuracies that may appear in this book The copyrighted software that accompanies this manual is licensed to the End User for use only in strict accordance with the End User License Agreement which the Licensee should read carefully before commencing use of the software Except as permitted above and by such licensing no part of this publication may be reproduced stored in a retrieval system or transmitted in any form or by any means electronic mechanical recording or otherwise without my prior written permission Contents Contents 1 Introduction 1 1 About thie manual s s so ans sa Soe rn a a we Boe da 1 2 Windows and Linux per sos so her a4 en a ee 2 Quick Start 3 Installation 3 1 Minimum System Requirements 2 2 2 EC nn 3 2 Installing the Ca3D Engine 2 2 Comm nn 3 3 Neradine 6 201000 a a a ar An eh ES 34 De Installation er 2 6 4 2 2 2428 a aachen 4 Running Ca3DE 4 1 The Options Dialog s
7. ONINFRINGEMENT Limitation of Liability THE AUTHOR SHALL NOT BE LIABLE IN ANY WAY FOR LOSS OR DAMAGE OF ANY KIND RESULTING FROM THE USE OF THE PROGRAM INCLUDING BUT NOT LIMITED TO LOSS OF GOODWILL WORK STOPPAGE COMPUTER FAILURE OR MALFUNCTION DATA LOSS DATA CORRUPTION OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES Responsibilities of End User Anyone distributing this product for any kind of remuneration must first contact me for authorization You may distribute this software to friends and colleagues but you must include all files in the original distribution without modification and no money must be taken You are expressly permitted to create new materials for the Program such as new worlds textures models or other artwork or a combination of those constituting entire modifications MODs You may not in whole or in part reproduce translate reverse engineer derive source code from modify disassemble decompile or create derivative works based on the Program or remove any proprietary notices or labels on the Program without the prior written consent of Carsten Fuchs You are entitled to use the Program for your own personal use but you are not entitled to 1 sell reproductions of the Program to other parties in any way nor to rent lease or license the Program to others 2 exploit the Program or any of its parts for any commercial purpose including but not limited to use at a cyber caf computer gam
8. SC key and then to choose a new world from the world list in the options dialog Pressing the key deactivates the console and brings you back to the game 10 5 Known Issues 5 Known Issues e The Linux port is still incomplete The Options dialog is missing e Sound drivers frequently cause problems under Linux Therefore Ca3DE ignores sound initialization failures on Linux prefering no or broken sound output over no functionality at all e So far Ca3DE works well on all the machines that I have seen However before now I had never seriously tested the network code under real Internet conditions e The dynamic shadows are not always correct The world is sometimes lit where no light should be and some problematic models cause ugly artefacts too e There are a few minor map specific problems ABonsCanyonTower shows false polygons where no polygons should be when you look out of the windows in some places Other maps show depth buffering artifacts e Use the latest drivers for your video card e Do not run Ca3DE from a full screen DOS Box It will report an error e I cannot guarantee that the engine will run properly or at all on your system In the eventuality that you can t make it run or you experience problems please don t hesitate to contact me by email I ll do my best to help you fix the problem 6 Contact Information It would be great if you told me what you think of this demo version of Ca3DE Any feedback
9. a Beta release e The artists mentioned in the Thanks section of the Ca3DE website generously permitted me to include their work with Ca3DE Foreign artwork that comes with Ca3DE is copyrighted by its respective authors e There is also artwork material in Ca3DE that is used without explicit permission I have included such material only under one of the following circumstances I found the material on the Internet and found no stated reference to its author or copyright I contacted the author but the email address was invalid I contacted the author but never received an answer I certainly do not want to infringe on anyone s copyright If you feel that there are any problems with the material that is included with Ca3DE please contact me so that we can get everything in order 13 B Glossary B Glossary The Ca3D Engine project consists of many executables has undergone many revisions and is likely to develop further Moreover the project has several names which are abbreviations of each other and which are used interchangeably on the website and throughout this entire manual Here is a description which should clarify what is what in a logical order Carsten This is my first name hence the engine name Carsten s 3D Engine Carsten s 3D Engine The full name of the 3D engine project Ca3D Engine An abbreviation of the project name which is commonly used Ca3DE Another frequently used abbreviation This ter
10. ber of connected players and so on Not yet implemented Ping Server Pings the server Mostly for development purposes but also inter esting as long as there are no other or automatic ping indicators Send NOP Sends a NOP packet to the server essentially instructing it to do nothing For development purposes Other options Currently unused Server Options This part lets you configure Ca3DE in its role as a Ca3DE server De pending on your choice of run mode not all fields will be available here Server port number The local network port number at which the server is reach able when it is running World name As several interesting worlds are included with each demo release this is usually the most important field when trying out Ca3DE The combo box lists all included worlds and lets you easily choose which one you wish to enter Other options Currently unused 4 2 Keyboard Layout In order to control the player and operate the game you can use the keys as shown in table 1 The demonstrated layout reflects both keyboard only player control layout and the popular mouse keyboard player control layout The keyboard layout will be made user configurable in future releases 4 3 The Command Console In order to activate or deactivate the console press the accent grave key This key is labeled on German keyboard layouts When the console is active all keyboard input goes to the console command line and the mouse input
11. d directories and then re install the new version as stated above I am sorry for any inconvenience caused by this but this is the best way to avoid many possible upgrade and version conflict problems 3 4 De Installation Because the installation makes no changes to your system it is sufficient to delete the Ca3D Engine folder for a completely clean de installation 4 Running Ca3DE 4 Running Ca3DE In order to start Ca3DE simply double click on the Ca3DE exe executable file This file is in the Ca3D Engine folder that was created during installation 4 1 The Options Dialog The Options Dialog is not yet implemented on Linux Ca3DE will skip it and apply the default options You can select other worlds either from the command line or via the in game console see section 4 3 After starting the Options Dialog appears as shown in figure 1 This dialog allows you to set up Ca3DE in various ways detailed below For your convenience I preconfigured the dialog settings so that you can almost always leave them as they are and simply press the OK button For a more sophisticated setup please read the rest of this section It explains the dialog details in greater depth Run Mode The upper part of the dialog asks you to choose which role Ca3DE should play in the network i e your LAN or the Internet I am calling this role the Ca3DE run mode There are three choices Client only Ca3DE acts as a Ca3DE client only This means that i
12. e Intel i386 compatible CPU with 1 0 GHz e 256 MB RAM e 3D graphics board with OpenGL support and programmable GPU like NVidia GeForce3 ATI Radeon 8500 e Windows 9x ME 2000 or XP or Linux operating system e TCP IP e On Windows DirectX 7 0 or higher In order to use the advanced networking features of Ca3DE the network environment of your system must be appropriately configured In other words if some of the modern commercial 3D computer games run on your system then this is a good indication that the Ca3D Engine will work too I am developing Ca3DE in the Windows 2000 and Debian Linux environment and I test it on as many platforms as I can get access to I have only very little experience with other varieties of Linux but have received only positive reports up to now regarding compatibility with all supported operating systems 3 2 Installing the Ca3D Engine In order to install the engine simply unzip the packed file that you downloaded from the website Please make sure that the directory structure is preserved This is the common extraction process for nearly all contemporary decompression software However for some older programs you need to explicitly specify a command line option or check a checkbox A new directory Ca3D Engine will be created and all files will be extracted into this directory 3 3 Upgrading In order to upgrade the engine from an older existing installation please delete all the old files an
13. ing center or any other location based site 12 A Legal 3 host or provide matchmaking services for the Program or emulate or redirect the communication protocols used by the author in the network feature of the Program if any through protocol emulation tunnelling modifying or adding components to the Program use of a utility program or any other techniques now known or hereafter developed for any commercial purpose including but not limited to com mercial network play over the Internet network play utilizing commercial gaming networks or as part of content aggregation networks you are permitted to host matchmaking services for the Program for Internet play solely on a non commercial basis e g without charge of any kind and on a non commercial site without any associated commercial activity such as advertising or commercial linking or fram ing The author has no liability and provides no warranty concerning the Internet play performance of the Program Miscellaneous YOU ACKNOWLEDGE THAT YOU HAVE READ THIS LICENSE UNDERSTAND IT AND AGREE TO BE BOUND BY ITS TERMS AS THE COMPLETE AND EX CLUSIVE STATEMENT OF THE AGREEMENT BETWEEN US SUPERSEDING ANY PROPOSAL OR PRIOR AGREEMENT ORAL OR WRITTEN AND ANY OTHER COMMUNICATIONS BETWEEN US RELATING TO THE SUBJECT MAT TER OF THIS LICENSE A 2 Notes e This program is a public test release of the Ca3D Engine which is also commonly called a demo version It is neither an Alpha nor
14. ld 14 B Glossary 15
15. m is also used as the file name for the main engine s executable Ca3DE exe CaBSP The name of the first compiling tool which is required in order to make worlds for Ca3DE This program is discussed in detail in the documentation of the Ca3DE New Materials Development Kit The corresponding executable file name is CaBSP exe CaPVS Another compiling tool CaLight The third compiling tool that performs the radiosity calculations for the Ca3DE worlds Map Most people use the two terms map and Tworld synonymously But for technical reasons I refer to a map as the static part of a world i e the walls the floors and the ceilings You will almost never see me use this word in texts that are not related to the internal workings of Ca3DE Map file In order to create a new Tworld for Ca3DE you begin with a map editor A map editor s output file is called a map file even though that is not entirely consistent with the definition of a Tmap Map files contain more information than merely a Tmap description such as Tworld specific data The TCaBSP compiler turns map files into world files World A world is the term for everything that contributes to a game at a given time That is to say a world consists of a Tmap players monsters the sky and everything else Level This term is synonymous to the term Tworld and is frequently used in other products It will almost never appear in Ca3DE but if it does it just means the same as Twor
16. mples include that Linux has tar gz file archives versus zip file archives on Windows and that the Linux executables are suffixed with linux versus exe on Windows I hope that this helps to keep this manual easy and intuitive to understand for every one The alternative would had been to mention all speficics for each OS in each text fragment and each example 2 Quick Start This section is intended for advanced users who are experienced with downloading and installing software If you are in a hurry and don t want to study the entire document but still want to make sure that you don t miss any of the important Ca3DE features you will find everything here to get you started e Please pay attention to the Legal section before you begin no matter what kind of hurry you are in e Installation is reduced to unzipping the packed file e Double clicking on Ca3DE exe starts the program e Optional In the options dialog choose another world from the list e The OX button starts the engine e The ESC key brings you back to the options dialog where you can either quit the program or choose another world from the list I recommend trying them all e For problem solving please consult the rest of this manual first If you can t find your answer here please write me an email 3 Installation 3 Installation 3 1 Minimum System Requirements Your computer system should meet the following minimum requirements for Ca3DE to run
17. t will connect to a Ca3DE server reachable from within the accessible network usually a LAN or the Internet Server only Ca3DE acts as a dedicated server only Other players can run Ca3DE on their computers in Client only run mode and connect to this server This is the preferred method of setting up an Internet server for Ca3DE However before doing so you should note that Ca3DE has not yet been extensively tested under real Internet conditions see section 5 Both Client and Server This is the dialog s default choice where Ca3DE starts up both a server and a client which communicate via your systems localhost This run mode is used both for single player games and for typical multi player LAN games where one doesn t want to operate an extra computer as the dedicated server The current release of Ca3DE actually doesn t differen tiate between these two cases Consequently when you start a single player game you are actually starting a multi player game with only one partici pating person That game is hosted on your machine and if your network is configured properly other players can join you in the game In this mode some of the other dialog fields are overridden and therefore grayed out Client Options This part lets you configure Ca3DE in its role as a Ca3DE client De pending on your choice of run mode not all fields will be available here Player name Your player name Other players see this name when you talk to
Download Pdf Manuals
Related Search