README_CUBEENGINE.txt 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. Cube source code license, usage, and documentation.
  2. You should read this file IN ITS ENTIRETY if you wish to do anything with
  3. the cube source code, even a mere build. Own builds are not necessarily
  4. compatible with the officially released binaries, read below.
  5. You may use the cube source code if you abide by the ZLIB license
  6. http://www.opensource.org/licenses/zlib-license.php
  7. (very similar to the BSD license) with the additional clause below:
  8. LICENSE
  9. =======
  10. Cube game engine source code, 20 dec 2003 release.
  11. Copyright (C) 2001-2003 Wouter van Oortmerssen.
  12. This software is provided 'as-is', without any express or implied
  13. warranty. In no event will the authors be held liable for any damages
  14. arising from the use of this software.
  15. Permission is granted to anyone to use this software for any purpose,
  16. including commercial applications, and to alter it and redistribute it
  17. freely, subject to the following restrictions:
  18. 1. The origin of this software must not be misrepresented; you must not
  19. claim that you wrote the original software. If you use this software
  20. in a product, an acknowledgment in the product documentation would be
  21. appreciated but is not required.
  22. 2. Altered source versions must be plainly marked as such, and must not be
  23. misrepresented as being the original software.
  24. 3. This notice may not be removed or altered from any source distribution.
  25. additional clause specific to Cube:
  26. 4. Source versions may not be "relicensed" under a different license
  27. without my explicitly written permission.
  28. LICENSE NOTES
  29. =============
  30. The license covers the source code found in the "src" directory of this
  31. archive, the included enet network library which cube uses is covered by
  32. the "No problem Bugroff" license, which is however compatible with the
  33. above license for all practical purposes.
  34. Game media included in the cube game (maps, textures, sounds, models etc.)
  35. are not covered by this license, and may have individual copyrights and
  36. distribution restrictions (see individual readmes).
  37. USAGE
  38. =====
  39. Compiling the sources should be straight forward.
  40. Unix users need to make sure to have the development version of all libs
  41. installed (OpenGL, SDL, SDL_Mixer, SDL_Image, zlib, libpng). The included
  42. makefiles can be used to build.
  43. Windows users can use the included visual studio .net 2003 project files, which
  44. references the lib/include directories for the external libraries and should
  45. thus be self contained. The project is set up assuming you have the normal
  46. cube binary distribution as a subdirectory "cube" of the root of this archive,
  47. so release mode builds will place executables in the bin dir ready for testing
  48. and distribution. Do not come ask me for help in compiling or modifying the
  49. sources, if you can't figure out how to do this yourself you probably shouldn't
  50. be touching the files anyway.
  51. The cube sources are very small, compact, and non redundant, so anyone
  52. wishing to modify the source code should be able to gain an overview of
  53. cube's inner workings by simply reading through the source code in its
  54. entirety. Small amounts of comments should guide you through the more
  55. tricky sections.
  56. When reading the source code and trying to understand cube's internal design,
  57. keep in mind the goal of cube: minimalism. I wanted to create a very complete
  58. game / game engine with absolutely minimal means, and made a sport out of it
  59. keeping the implementation small and simple. Cube is not a commercial product,
  60. it is merely the author's idea of a fun little programming project.
  61. OPEN SOURCE
  62. ===========
  63. Cube is open source (see ZLIB license above). This only means that you have
  64. great freedom using it for your own projects, but does NOT mean the main cube
  65. code is an "open source project" in the sense that everyone is invited to
  66. contribute to it. The main cube code will remain a one man project (me), as my
  67. minimalistic design is highly incompatible with the open source philosophy. If you
  68. add to the cube source code, you fork the code and it becomes your own project,
  69. do not ask for me to integrate your changes into the main branch, no matter
  70. how brilliant they are.
  71. CHEATING
  72. ========
  73. If you want to use cube as a base for a game where the multiplayer aspect is
  74. important and used by a large community, you need to be aware that cube's
  75. thick client - thin server architecture is extremely cheat sensitive. If you
  76. release a cube based game with source code equivalent to the binaries, some
  77. minor changes can give anyone an aimbot or other cheats in online games.
  78. There are several ways to make this less easy, some of which are:
  79. 1. only distribute binaries (the ZLIB license allows this). Executables can still
  80. be hacked, but unless you have a really large online community, noone will
  81. probably bother.
  82. 2. write a network proxy, such as qizmo used with QuakeWorld (whose sources are
  83. also open source). The proxy is a small closed source program that checksums
  84. the executable, and maybe also some game media. You can then make servers
  85. or game admins request this information and ban cheaters.
  86. 3. release the sources with an incompatible network protocol or other changes
  87. compared to the binaries you release.
  88. 4. build serious cheat detection into the game. Since all clients are their own
  89. "servers", you can make them all keep track of stats for the other players,
  90. such as health etc. you can make all sorts of consistency checks on shots,
  91. movement speed and items. If the discrepancy for a certain client becomes
  92. too big, all clients but the cheater can send their "vote" to the server
  93. for having him banned. Even better, you can add server side stat checking.
  94. For the cube's own game I chose option 3, i.e. you can only play the official
  95. cube game using the binaries supplied by me, and you can't compile your own clients
  96. for multiplayer use (you can still make custom clients that work with matching
  97. custom servers, or play cube single player maps compatible with the real thing).
  98. This situation is not ideal, but there is no easy way around it.
  99. This scheme is probably very easy to defeat if you are capable of using disassemblers
  100. and packet sniffers, but please contrain yourself and don't ruin the fun of the
  101. cube multiplayer community. Thanks.
  102. AUTHOR
  103. ======
  104. Wouter van Oortmerssen aka Aardappel
  105. wvo@fov120.com
  106. http://wouter.fov120.com
  107. For additional authors/contributors, see the cube binary distribution readme.html