| 1 | ==========================================================================
|
|---|
| 2 | Cafu Game and Graphics Engine http://www.cafu.de
|
|---|
| 3 | Demo Readme info@cafu.de
|
|---|
| 4 | ==========================================================================
|
|---|
| 5 |
|
|---|
| 6 | Welcome to Cafu, the open-source Game and Graphics Engine for
|
|---|
| 7 | multiplayer, cross-platform, real-time 3D Action.
|
|---|
| 8 |
|
|---|
| 9 | This readme gets you started with the Cafu binary demo packages. The
|
|---|
| 10 | demo packages are archives that contain precompiled program executables
|
|---|
| 11 | and everything else that is required to run the Cafu engine demo.
|
|---|
| 12 | If you are interested in getting and compiling the source code instead,
|
|---|
| 13 | refer to the Cafu documentation at http://www.cafu.de/wiki/
|
|---|
| 14 |
|
|---|
| 15 | Contents of this file:
|
|---|
| 16 |
|
|---|
| 17 | 1. Quick-start for Windows
|
|---|
| 18 | 2. Quick-start for Linux
|
|---|
| 19 | 3. Documentation
|
|---|
| 20 | 4. Release Notes
|
|---|
| 21 | 5. License
|
|---|
| 22 | 6. Contact
|
|---|
| 23 |
|
|---|
| 24 |
|
|---|
| 25 |
|
|---|
| 26 | ==========================================================================
|
|---|
| 27 | 1. Quick-start for Windows
|
|---|
| 28 | ==========================================================================
|
|---|
| 29 |
|
|---|
| 30 | You can run the Cafu demo by clicking on the Cafu.exe file that is in
|
|---|
| 31 | the same directory as this README.txt file.
|
|---|
| 32 |
|
|---|
| 33 | Your Windows or Personal Firewall may report Cafu opening a network
|
|---|
| 34 | connection. This is because Cafu starts a client and a server, then
|
|---|
| 35 | connects to itself even for pure single-player games.
|
|---|
| 36 | Thus, please set your firewall to not block Cafu from network access.
|
|---|
| 37 |
|
|---|
| 38 | The Cafu World Editor "CaWE" is started analogously by clicking on
|
|---|
| 39 | the CaWE.exe file in the same directory.
|
|---|
| 40 |
|
|---|
| 41 | More information about the Cafu engine and the editor CaWE can be
|
|---|
| 42 | found in the documentation at http://www.cafu.de/wiki/
|
|---|
| 43 |
|
|---|
| 44 |
|
|---|
| 45 |
|
|---|
| 46 | ==========================================================================
|
|---|
| 47 | 2. Quick-start for Linux
|
|---|
| 48 | ==========================================================================
|
|---|
| 49 |
|
|---|
| 50 | Extracting the Cafu .tar.gz archive makes automatically sure
|
|---|
| 51 | that the executable bit is properly set for all relevant files, and
|
|---|
| 52 | thus you can (double-)click the "Cafu-run" file that is in the same
|
|---|
| 53 | directory as this README.txt file in order to start the Cafu engine.
|
|---|
| 54 | "Cafu-run" is a shell script that sets the proper working directory
|
|---|
| 55 | before starting the Cafu executable.
|
|---|
| 56 |
|
|---|
| 57 | Alternatively, you can run Cafu from a command line shell by cd'ing
|
|---|
| 58 | into the same directory as this file (e.g. cd ~carsten/Cafu/ ), and
|
|---|
| 59 | then just type ./Cafu
|
|---|
| 60 |
|
|---|
| 61 | The Cafu World Editor "CaWE" is started analogously by clicking on
|
|---|
| 62 | the "CaWE-run" file or by running ./CaWE-bin respectively.
|
|---|
| 63 |
|
|---|
| 64 | More information about the Cafu engine and the editor CaWE can be
|
|---|
| 65 | found in the documentation at http://www.cafu.de/wiki/
|
|---|
| 66 |
|
|---|
| 67 |
|
|---|
| 68 |
|
|---|
| 69 | ==========================================================================
|
|---|
| 70 | 3. Documentation
|
|---|
| 71 | ==========================================================================
|
|---|
| 72 |
|
|---|
| 73 | If you need help, please refer to the user manual at
|
|---|
| 74 | http://www.cafu.de/wiki/. It has a "Quick Start" section that
|
|---|
| 75 | briefly summarizes everything to get you started, and also has more
|
|---|
| 76 | detailed information about installing, de-installing, requirements etc.
|
|---|
| 77 |
|
|---|
| 78 | Additional documentation and information about all advanced aspects of
|
|---|
| 79 | Cafu (e.g. map editing and development) is found at
|
|---|
| 80 |
|
|---|
| 81 | a) the Cafu wiki at http://www.cafu.de/wiki/
|
|---|
| 82 | b) the Cafu forum at http://www.cafu.de/forum/
|
|---|
| 83 |
|
|---|
| 84 |
|
|---|
| 85 |
|
|---|
| 86 | ==========================================================================
|
|---|
| 87 | 4. Release Notes
|
|---|
| 88 | ==========================================================================
|
|---|
| 89 |
|
|---|
| 90 | Known problems specific to all supported platforms:
|
|---|
| 91 | None.
|
|---|
| 92 |
|
|---|
| 93 | Known problems specific to the Windows platform:
|
|---|
| 94 | a) Occasionally distorted background music playback in the TechDemo
|
|---|
| 95 | map near the base of the ladder to the emergency exit.
|
|---|
| 96 |
|
|---|
| 97 | Known problems specific to the Linux platform:
|
|---|
| 98 | a) Screen resolution cannot be changed at runtime (this is a
|
|---|
| 99 | limitation of the X server, not Cafu).
|
|---|
| 100 | b) Blank/black screen after starting. On some systems, it takes a long
|
|---|
| 101 | time between starting the engine and the initial appearance of the
|
|---|
| 102 | "Loading..." screen. The screen is then fully black, and it takes up
|
|---|
| 103 | to one or two minutes until the splash screen appears. This problem
|
|---|
| 104 | has only been observed on systems that do not meet the minimum system
|
|---|
| 105 | requirements, and is due to inadequate hardware and/or driver support.
|
|---|
| 106 |
|
|---|
| 107 |
|
|---|
| 108 |
|
|---|
| 109 | ==========================================================================
|
|---|
| 110 | 5. License
|
|---|
| 111 | ==========================================================================
|
|---|
| 112 |
|
|---|
| 113 | Please refer to file LICENSE.txt in the same directory as this readme
|
|---|
| 114 | for license information.
|
|---|
| 115 |
|
|---|
| 116 |
|
|---|
| 117 |
|
|---|
| 118 | ==========================================================================
|
|---|
| 119 | 6. Contact
|
|---|
| 120 | ==========================================================================
|
|---|
| 121 |
|
|---|
| 122 | If you experience problems or if you have any questions or suggestions,
|
|---|
| 123 | visit the official Cafu website at
|
|---|
| 124 |
|
|---|
| 125 | http://www.cafu.de
|
|---|
| 126 |
|
|---|
| 127 | You will find background information, discussion forums, IRC chat
|
|---|
| 128 | details, and many other resources to help you out. You're heartily
|
|---|
| 129 | invited to join the forums and the IRC chat to place your questions and
|
|---|
| 130 | suggestions.
|
|---|
| 131 |
|
|---|
| 132 | You can also contact the Cafu author Carsten Fuchs directly by
|
|---|
| 133 | sending an email to
|
|---|
| 134 |
|
|---|
| 135 | info@cafu.de
|
|---|
