fix issue with looping audio streams
[taylor/freespace2.git] / README
1 ----------------------------------------------
2 Freespace 2 (http://www.freespace2.com)
3             - A game by Volition, Inc. (http://www.volition-inc.com)
4
5 This project is NOT supported by Volition or Interplay.
6
7 http://www.icculus.org/freespace2/
8
9 Based on the Freespace 2 source code:
10 Copyright (C) Volition, Inc. 1999.  All rights reserved.
11
12 All source code herein is the property of Volition, Inc. You may not sell
13 or otherwise commercially exploit the source or things you created based on
14 the source.
15 ----------------------------------------------
16
17 06/18/2002
18
19 Current status:
20 - You need data files to run this.  You can use the Freespace 2 demo or
21 install the full game with wine.  If your commercial version of Freespace 2
22 is not the Game of the Year edition, you'll need to update to the latest
23 patch before copying the data files over.
24
25 - It currently uses SDL (http://www.libsdl.org) and OpenAL
26 (http://opensource.creative.com)
27
28 - The OpenGL code is complete minus one or two things, but it is unoptimized.
29
30 - Keyboard, mouse, and joystick work.
31
32 - Lots of debug messages.  Recompile with NDEBUG defined to get rid of them.
33
34 - The build currently defaults to the full version.  To build the demo
35 version, edit the Makefile by changing the DEMO flag from "false" to "true".
36 Mods, etc. have not been tested.
37
38 - Networking (TCP) seems to work OK.  Linux<->Linux works great, Lin<->Win
39 tested a little (with Linux client acting as the server, Windows server may
40 cause problems with filenames and transferred files).
41
42 - Sound code is only partially implemented.
43
44 - Currently all files (*.vp) need to be in the current working directory.
45
46 - The Windows version might still compile, but wasn't tested.  (The
47 Linux-specific code is separated by a PLAT_UNIX define).  Fred2, etc., were
48 not touched.
49
50 - This code builds on MacOS X. Get the latest toolchain from Apple. Flip the
51 MACOSX flag in the Makefile to "true" and run "make" from a terminal in the
52 root of the source directory. Note that the game compiles and links, but will
53 NOT run at this time, due to byte ordering bugs in the source.
54
55 For more information about the game and its source code:
56 http://www.freespace2.com/
57 http://www.volitionwatch.com/
58 http://fs2source.warpcore.org/