wolf3d

The original open source release of Wolfenstein 3D
Log | Files | Refs

README.rst (10259B)


      1 Wolfenstein 3D
      2 ==============
      3 
      4 The original source release was made using the ``DEICE.EXE``
      5 installer (DeIce) in the root directory.  (Basically a way to
      6 split self-extracting zip files over multiple floppy disks.)
      7 After execution, that installer will create the contents of
      8 the ``WOLFSRC`` directory.  In the "installed" directory, the
      9 the ``README.TXT``, ``RELEASE.TXT``, and ``LICENCE.DOC`` reside
     10 in the ``README`` directory.  They are duplicated below.
     11 
     12 Travis "Ash" Bradshaw <travis.bradshaw@idsoftware.com>
     13 
     14 February 6, 2012
     15 
     16 RELEASE.TXT
     17 -----------
     18 
     19 ::
     20 
     21   We are releasing this code for the entertainment of the 
     22   user community.  We don't guarentee that anything even 
     23   builds in here.  Projects just seem to rot when you leave 
     24   them alone for long periods of time.
     25 
     26   This is all the source we have relating to the original 
     27   PC wolfenstein 3D project.  We haven't looked at this 
     28   stuff in years, and I would probably be horribly embarassed 
     29   to dig through my old code, so please don't ask any questions 
     30   about it. The original project was built in borland c++ 3.0.  
     31   I think some minor changes were required for later versions.
     32 
     33   You will need the data from a released version of wolf or spear 
     34   to use the exe built from this code.  You can just use a 
     35   shareware version if you are really cheap.
     36 
     37 
     38   Some coding comments in retrospect:
     39 
     40   The ray casting refresh architecture is still reasonably 
     41   appropriate for the game.  A BSP based texture mapper could 
     42   go faster, but ray casting was a lot simpler to do at the time.
     43 
     44   The dynamically compiled scaling routines are now a Bad Thing.  
     45   On uncached machines (the original target) they are the fastest 
     46   possible way to scale walls, but on modern processors you just 
     47   wind up thrashing the code cash and wrecking performance.  
     48   A simple looping texture mapper would be faster on 486+ machines.
     49 
     50   The whole page manager caching scheme is unecessarily complex.
     51 
     52   Way too many #ifdefs in the code!
     53 
     54 
     55   Some project ideas with this code:
     56 
     57   Add new monsters or weapons.
     58 
     59   Add taller walls and vertical motion.   This should only be 
     60   done if the texture mapper is rewritten.
     61 
     62   Convert to a 32 bit compiler.  This would be a fair amount 
     63   of work, but I would hate to even mess with crusty old 16 
     64   bit code.  The code would get a LOT smaller.
     65 
     66   Make a multi-player game that runs on DOOM sersetup / ipxsetup drivers.
     67 
     68 
     69   Have fun...
     70 
     71   John Carmack
     72   Technical Director
     73   Id Software
     74 
     75 README.TXT
     76 ----------
     77 
     78 NOTES:
     79 
     80 This version will compile under BORLAND C++ 3.0/3.1 and compiled perfectly
     81 before it was uploaded. 
     82 
     83 Please do not send your questions to id Software.
     84 
     85 LICENCE.DOC
     86 -----------
     87 
     88  :: 
     89   	LIMITED USE SOFTWARE LICENSE AGREEMENT
     90 
     91   	This Limited Use Software License Agreement (the "Agreement") 
     92   is a legal agreement between you, the end-user, and Id Software, Inc. 
     93   ("ID").  By continuing the downloading of this Wolfenstein 3D 
     94   (the "Trademark") software material, which includes source code 
     95   (the "Source Code"), artwork data, music and software tools 
     96   (collectively, the "Software"), you are agreeing to be bound by the 
     97   terms of this Agreement.  If you do not agree to the terms of this 
     98   Agreement, promptly destroy the Software you may have downloaded.  
     99 
    100   ID SOFTWARE LICENSE
    101 
    102   	Grant of License.  ID grants to you the right to use one (1) 
    103   copy of the Software on a single computer.  You have no ownership or 
    104   proprietary rights in or to the Software, or the Trademark.  For purposes 
    105   of this section, "use" means loading the Software into RAM, as well as 
    106   installation on a hard disk or other storage device.  The Software, 
    107   together with any archive copy thereof, shall be destroyed when no longer 
    108   used in accordance with this Agreement, or when the right to use the 
    109   Software is terminated.  You agree that the Software will not be shipped, 
    110   transferred or exported into any country in violation of the U.S. 
    111   Export Administration Act (or any other law governing such matters) and 
    112   that you will not utilize, in any other manner, the Software in violation 
    113   of any applicable law.
    114 
    115   	Permitted Uses.  For educational purposes only, you, the end-user, 
    116   may use portions of the Source Code, such as particular routines, to 
    117   develop your own software, but may not duplicate the Source Code, except 
    118   as noted in paragraph 4.  The limited right referenced in the preceding 
    119   sentence is hereinafter referred to as "Educational Use."  By so exercising 
    120   the Educational Use right you shall not obtain any ownership, copyright,
    121   proprietary or other interest in or to the Source Code, or any portion of
    122   the Source Code.  You may dispose of your own software in your sole
    123   discretion.  With the exception of the Educational Use right, you may not
    124   otherwise use the Software, or an portion of the Software, which includes
    125   the Source Code, for commercial gain.
    126 
    127   	Prohibited Uses:  Under no circumstances shall you, the end-user, 
    128   be permitted, allowed or authorized to commercially exploit the Software.
    129   Neither you nor anyone at your direction shall do any of the following acts
    130   with regard to the Software, or any portion thereof:
    131 
    132   	Rent;
    133 
    134   	Sell;
    135 
    136   	Lease;
    137 
    138   	Offer on a pay-per-play basis;
    139 
    140   	Distribute for money or any other consideration; or
    141 
    142   	In any other manner and through any medium whatsoever commercially 
    143   exploit or use for any commercial purpose.
    144 
    145   Notwithstanding the foregoing prohibitions, you may commercially exploit the
    146   software you develop by exercising the Educational Use right, referenced in
    147   paragraph 2. hereinabove. 
    148 
    149   	Copyright.  The Software and all copyrights related thereto 
    150   (including all characters and other images generated by the Software 
    151   or depicted in the Software) are owned by ID and is protected by 
    152   United States copyright laws and international treaty provisions.  
    153   Id shall retain exclusive ownership and copyright in and to the Software 
    154   and all portions of the Software and you shall have no ownership or other 
    155   proprietary interest in such materials. You must treat the Software like 
    156   any other copyrighted material, except that you may either (a) make one 
    157   copy of the Software solely for back-up or archival purposes, or (b) 
    158   transfer the Software to a single hard disk provided you keep the original 
    159   solely for back-up or archival purposes.  You may not otherwise reproduce, 
    160   copy or disclose to others, in whole or in any part, the Software.  You 
    161   may not copy the written materials accompanying the Software.  You agree 
    162   to use your best efforts to see that any user of the Software licensed 
    163   hereunder complies with this Agreement.
    164 
    165   	NO WARRANTIES.  ID DISCLAIMS ALL WARRANTIES, BOTH EXPRESS IMPLIED,
    166   INCLUDING BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND
    167   FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THE SOFTWARE.  THIS LIMITED
    168   WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS.  YOU MAY HAVE OTHER RIGHTS WHICH
    169   VARY FROM JURISDICTION TO JURISDICTION.  ID DOES NOT WARRANT THAT THE
    170   OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED, ERROR FREE OR MEET YOUR
    171   SPECIFIC REQUIREMENTS.  THE WARRANTY SET FORTH ABOVE IS IN LIEU OF ALL OTHER
    172   EXPRESS WARRANTIES WHETHER ORAL OR WRITTEN.  THE AGENTS, EMPLOYEES,
    173   DISTRIBUTORS, AND DEALERS OF ID ARE NOT AUTHORIZED TO MAKE MODIFICATIONS TO
    174   THIS WARRANTY, OR ADDITIONAL WARRANTIES ON BEHALF OF ID. 
    175 
    176   	Exclusive Remedies.  The Software is being offered to you free of any
    177   charge.  You agree that you have no remedy against ID, its affiliates,
    178   contractors, suppliers, and agents for loss or damage caused by any defect
    179   or failure in the Software regardless of the form of action, whether in
    180   contract, tort, includinegligence, strict liability or otherwise, with
    181   regard to the Software.  This Agreement shall be construed in accordance
    182   with and governed by the laws of the State of Texas.  Copyright and other
    183   proprietary matters will be governed by United States laws and international
    184   treaties.  IN ANY CASE, ID SHALL NOT BE LIABLE FOR LOSS OF DATA, LOSS OF
    185   PROFITS, LOST SAVINGS, SPECIAL, INCIDENTAL, CONSEQUENTIAL, INDIRECT OR OTHER
    186   SIMILAR DAMAGES ARISING FROM BREACH OF WARRANTY, BREACH OF CONTRACT,
    187   NEGLIGENCE, OR OTHER LEGAL THEORY EVEN IF ID OR ITS AGENT HAS BEEN ADVISED
    188   OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY.
    189   Some jurisdictions do not allow the exclusion or limitation of incidental or
    190   consequential damages, so the above limitation or exclusion may not apply to
    191   you.
    192 
    193   	General Provisions.  Neither this Agreement nor any part or portion 
    194   hereof shall be assigned, sublicensed or otherwise transferred by you.  
    195   Should any provision of this Agreement be held to be void, invalid, 
    196   unenforceable or illegal by a court, the validity and enforceability of the 
    197   other provisions shall not be affected thereby.  If any provision is 
    198   determined to be unenforceable, you agree to a modification of such 
    199   provision to provide for enforcement of the provision's intent, to the 
    200   extent permitted by applicable law.  Failure of a party to enforce any 
    201   provision of this Agreement shall not constitute or be construed as a 
    202   waiver of such provision or of the right to enforce such provision.  If 
    203   you fail to comply with any terms of this Agreement, YOUR LICENSE IS 
    204   AUTOMATICALLY TERMINATED and you agree to the issuance of an injunction 
    205   against you in favor of Id.  You agree that Id shall not have to post 
    206   bond or other security to obtain an injunction against you to prohibit 
    207   you from violating Id's rights.
    208 
    209   	YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, THAT YOU 
    210   UNDERSTAND THIS AGREEMENT, AND UNDERSTAND THAT BY CONTINUING THE 
    211   DOWNLOADING OF THE SOFTWARE, YOU AGREE TO BE BOUND BY THIS AGREEMENT'S 
    212   TERMS AND CONDITIONS. YOU FURTHER AGREE THAT, EXCEPT FOR WRITTEN SEPARATE 
    213   AGREEMENTS BETWEEN ID AND YOU, THIS AGREEMENT IS A COMPLETE AND EXCLUSIVE 
    214   STATEMENT OF THE RIGHTS AND LIABILITIES OF THE PARTIES.  THIS AGREEMENT 
    215   SUPERSEDES ALL PRIOR ORAL AGREEMENTS, PROPOSALS OR UNDERSTANDINGS, AND 
    216   ANY OTHER COMMUNICATIONS BETWEEN ID AND YOU RELATING TO THE SUBJECT MATTER 
    217   OF THIS AGREEMENT 
    218