home *** CD-ROM | disk | FTP | other *** search
/ Virtual Reality Homebrewer's Handbook / vr.iso / avril / read.me < prev    next >
Text File  |  1996-03-19  |  5KB  |  127 lines
  1.  
  2.                                   AVRIL
  3.  
  4. This is release 2.0 of AVRIL, a library for creating virtual reality
  5. applications.
  6.  
  7. Changes since 1.1 include:
  8.     HMD support:
  9.         CyberMaxx (VictorMaxx Technologies)
  10.         i-glasses! (Virtual i/o)
  11.         7th Sense (All-Pro)
  12.     support for CyberWand from InWorld VR
  13.     support for the FifthGlove from 5DT
  14.     stereoscopic viewing
  15.     Gouraud shading
  16.     modular video driver
  17.     modular display driver
  18.  
  19. These changes are detailed in Appendix A of the documentation file.
  20.  
  21. Unfortunately, there are some features that are not fully implemented.
  22.  
  23.     The Gouraud shading has a few flaws (little glitches here and there
  24.     in the shading), and hasn't been exhaustively tested; it's the last
  25.     feature I added before the release.  It's also very slow; using a
  26.     little bit of assembly language here should speed it up considerably,
  27.     but I'll save that for the next release.
  28.  
  29.     Not all the stereo modes are implemented yet.
  30.  
  31.     The horizon code was always broken, so I've temporarily
  32.     disabled it; I hope to completely rewrite it for a future
  33.     release, adding a "stepped" or "layered" horizon; if anyone
  34.     has any code for doing this that they'd like to contribute,
  35.     let me know!
  36.  
  37. The current version of the code is also relatively slow, since I've
  38. converted everything to C (no assembly language at all) and haven't done
  39. any optimization.  This is the final stage before porting to other
  40. platforms; once the ports have been done, I'll be re-optimizing the PC
  41. version and putting assembler into a few time-critical routines (thereby
  42. getting the speed back up).
  43.  
  44. The latest version of this software can always be found on sunee.uwaterloo.ca,
  45. in the pub/avril directory.
  46.  
  47. CONTENTS
  48.  
  49. The contents of this archive are as follows:
  50.  
  51. read.me         this file
  52. av.exe          the world-viewing program
  53. av.c            the source code for av.exe
  54. avril.cfg       the configuration file for av.exe
  55. hardware.cfg    sample configurations for various devices
  56. avril.h         the AVRIL header file
  57. avril.lib       the AVRIL library
  58. avrilkey.h      definitions of keycodes
  59. avrildrv.h      definitions for device driver functions
  60. example1.c      example 1 from the AVRIL tutorial
  61. example2.c      example 2 from the AVRIL tutorial
  62. example3.c      example 3 from the AVRIL tutorial
  63. example4.c      example 4 from the AVRIL tutorial
  64. example5.c      example 5 from the AVRIL tutorial
  65. example6.c      example 6 from the AVRIL tutorial
  66. example6.cfg    the configuration file for example6
  67. example7.c      example 7 from the AVRIL tutorial
  68. shade32.pal     a palette used by example7
  69. input.c         source code for some routines used by all the examples
  70. system.c        source code for some of the system routines
  71. cfg.c           source code for the configuration file parser
  72. drvcyman.c      sample driver source code (for the Logitech Cyberman)
  73. vidsamp.c       sample source code for low-level video driver (mode 0x13)
  74. packet.c        source code for collecting packets of binary data
  75. avriltut.ps     the AVRIL tutorial, in Postscript
  76. avriltut.txt    the AVRIL tutorial, in plain ASCII
  77. avrilref.ps     the AVRIL technical reference manual, in Postscript
  78. avrilref.txt    the AVRIL technical reference manual, in plain ASCII
  79. avrilapp.ps     the AVRIL tech ref appendices manual, in Postscript
  80. avrilapp.txt    the AVRIL tech ref appendices manual, in plain ASCII
  81. asteroid.plg    a PLG file used by example2
  82. colorful.plg    a PLG file used by example3
  83. sample.zip      the data for a sample world
  84.  
  85. USING AV
  86.  
  87. Unzip sample.zip, using the -d option to create a directory for the sample
  88. world.  In other words, type "unzip -d sample".
  89.  
  90. To run AV, just type "av sample.wld".  You can also view individual PLG
  91. files and FIG files using AV.
  92.  
  93. MOVING AROUND
  94.  
  95. Moving around the virtual environment is easy.  The following applies to AV
  96. or any of the example programs (once they've been compiled).
  97.  
  98.          Key                                  Function
  99.  
  100.     up/down arrows                      move forward/backward
  101.     left/right arrows                   turn left/right
  102.     leftshift plus up/down arrows       move up/down
  103.     leftshift plus left/right arrows    move left/right
  104.     rightshift plus up/down arrows      look up/down
  105.     rightshift plus left/right arrows   tilt head left/right
  106.  
  107. OTHER KEYS
  108.  
  109. The following keys perform various functions:
  110.  
  111.     ESC     quit
  112.      f      toggle frame rate display
  113.      c      toggle compass display
  114.      p      toggle position display
  115.      d      toggle display of debugging information
  116.      _      (underscore) toggle horizon off/on
  117.     +,-     zoom in, out
  118.      =      reset zoom
  119.     h,H     adjust hither clipping plane distance by current space step
  120.      w      toggle wireframe mode
  121.   (space)   toggle mouse mode between 6D input and on-screen selection
  122.  
  123. CONTACTING THE AUTHOR
  124.  
  125. My email address is broehl@sunee.uwaterloo.ca; mention AVRIL in the
  126. subject line so I'll know what it's about.
  127.