Skip to content

Latest commit

 

History

History
149 lines (94 loc) · 5.57 KB

INSTALL.txt

File metadata and controls

149 lines (94 loc) · 5.57 KB
 
May 10, 2002
May 10, 2002
1
Jun 11, 2002
Jun 11, 2002
2
3
The latest PhysicsFS information and releases can be found at:
http://icculus.org/physfs/
May 10, 2002
May 10, 2002
4
Apr 24, 2002
Apr 24, 2002
5
Building is (ahem) very easy.
Jul 28, 2001
Jul 28, 2001
6
Aug 23, 2001
Aug 23, 2001
7
8
ALL PLATFORMS:
Sep 2, 2001
Sep 2, 2001
9
Mar 11, 2007
Mar 11, 2007
10
11
Please understand your rights and mine: read the text file LICENSE.txt in the
root of the source tree. If you can't abide by it, delete this source tree
Mar 11, 2007
Mar 11, 2007
12
13
now. The license is extremely liberal, even to closed-source, commercial
applications.
Aug 23, 2001
Aug 23, 2001
14
Jun 11, 2002
Jun 11, 2002
15
16
If you've got Doxygen (http://www.doxygen.org/) installed, you can run it
without any command line arguments in the root of the source tree to generate
Mar 11, 2007
Mar 11, 2007
17
18
19
20
21
the API reference (or build the "docs" target from your build system). This
is optional. You can browse the API docs online here:
http://icculus.org/physfs/docs/
Jun 11, 2002
Jun 11, 2002
22
Aug 23, 2001
Aug 23, 2001
23
24
Aug 30, 2002
Aug 30, 2002
25
UNIX:
Jul 28, 2001
Jul 28, 2001
26
Mar 11, 2007
Mar 11, 2007
27
28
29
30
31
32
33
34
You will need CMake (http://www.cmake.org/) 2.4 or later installed.
Run "cmake ." in the root of the source directory to generate Makefiles.
You can then run "ccmake ." and customize the build, but the defaults are
probably okay. You can have CMake generate KDevelop project files if you
prefer these.
Run "make". PhysicsFS will now build.
Jul 28, 2001
Jul 28, 2001
35
May 24, 2002
May 24, 2002
36
As root, run "make install".
Mar 11, 2007
Mar 11, 2007
37
38
If you get sick of the library, run "xargs rm < install_manifest.txt" as root
and it will remove all traces of the library from the system paths.
Jul 28, 2001
Jul 28, 2001
39
Aug 30, 2002
Aug 30, 2002
40
Primary Unix development is done with GNU/Linux, but PhysicsFS is known to
Mar 11, 2007
Mar 11, 2007
41
42
43
work out of the box with several flavors of Unix. It it doesn't work, patches
to get it running can be sent to icculus@icculus.org.
Jun 11, 2002
Jun 11, 2002
44
45
Aug 30, 2002
Aug 30, 2002
46
BeOS:
Mar 11, 2007
Mar 11, 2007
47
48
Use the "Unix" instructions, above. The CMake port to BeOS is fairly new at
Apr 3, 2007
Apr 3, 2007
49
50
the time of this writing, but it works. You can get a build of CMake from
bebits.com or build it yourself from source from cmake.org.
Aug 30, 2002
Aug 30, 2002
51
52
53
Mar 11, 2007
Mar 11, 2007
54
Windows:
Aug 23, 2001
Aug 23, 2001
55
Jun 11, 2002
Jun 11, 2002
56
If building with CygWin, mingw32 or something else that uses the GNU
Mar 11, 2007
Mar 11, 2007
57
toolchain, follow the Unix instructions, above.
Jun 11, 2002
Jun 11, 2002
58
Mar 11, 2007
Mar 11, 2007
59
60
If you want to use Visual Studio, nmake, or the Platform SDK, you will need
CMake (http://www.cmake.org/) 2.4 or later installed. Point CMake at the
Apr 3, 2007
Apr 3, 2007
61
62
63
64
65
66
67
68
69
CMakeLists.txt file in the root of the source directory and hit the
"Configure" button. After telling it what type of compiler you are targeting
(Borland, Visual Studio, etc), CMake will process for while and then give you
a list of options you can change (what archivers you want to support, etc).
If you aren't sure, the defaults are probably fine. Hit the "Configure"
button again, then "OK" once configuration has completed with options that
match your liking. Now project files for your favorite programming
environment will be generated for you in the directory you specified.
Go there and use them to build PhysicsFS.
Jun 11, 2002
Jun 11, 2002
70
Mar 11, 2007
Mar 11, 2007
71
72
73
74
75
PhysicsFS will only link directly against system libraries that have existed
since Windows 95 and Windows NT 3.51. If there's a newer API we want to use,
we try to dynamically load it at runtime and fallback to a reasonable
behaviour when we can't find it...this is used for Unicode support and
locating user-specific directories, etc.
Aug 9, 2003
Aug 9, 2003
76
Mar 11, 2007
Mar 11, 2007
77
78
79
PhysicsFS has not been tested on 64-bit Windows, but probably works. There is
no 16-bit Windows support at all. Reports of success and problems can go to
Ryan at icculus@icculus.org ...
Jun 11, 2002
Jun 11, 2002
80
Mar 11, 2007
Mar 11, 2007
81
82
If someone is willing to maintain prebuilt PhysicsFS DLLs, I'd like to hear
from you; send an email to icculus@icculus.org ...
Aug 9, 2003
Aug 9, 2003
83
Apr 24, 2002
Apr 24, 2002
84
85
Mar 11, 2007
Mar 11, 2007
86
87
88
89
90
91
92
93
94
PocketPC/WindowsCE:
Code exists for PocketPC support, and there are shipping titles that used
PhysicsFS 1.0 on PocketPC...but it isn't tested in 2.0, and is probably
broken with the new build system. Please send patches.
MAC OS 8/9:
Sep 2, 2001
Sep 2, 2001
95
Mar 14, 2007
Mar 14, 2007
96
97
98
99
100
101
102
103
Classic Mac OS support has been dropped in PhysicsFS 2.0. Apple hasn't updated
pre-OSX versions in almost a decade at this point, none of the hardware
they've shipped will boot it for almost as many years, and finding
developer tools for it is becoming almost impossible. As the switch to Intel
hardware has removed the "Classic" emulation environment, it was time to
remove support from PhysicsFS. That being said, the PhysicsFS 1.0 branch can
still target back to Mac OS 8.5, so you can use that if you need support for
this legacy OS. We still very much support Mac OS X, though: see below.
Mar 11, 2007
Mar 11, 2007
104
105
Apr 6, 2002
Apr 6, 2002
106
Mar 11, 2007
Mar 11, 2007
107
MAC OS X:
Apr 6, 2002
Apr 6, 2002
108
Mar 11, 2007
Mar 11, 2007
109
You will need CMake (http://www.cmake.org/) 2.4 or later installed.
Jun 11, 2002
Jun 11, 2002
110
Mar 11, 2007
Mar 11, 2007
111
112
You can either generate a Unix makefile with CMake, or generate an Xcode
project, whichever makes you more comfortable.
Jun 11, 2002
Jun 11, 2002
113
Mar 11, 2007
Mar 11, 2007
114
PowerPC and Intel Macs should both be supported.
Jun 11, 2002
Jun 11, 2002
115
116
If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
Mar 11, 2007
Mar 11, 2007
117
118
Mac OS X, I'd like to hear from you; send an email to icculus@icculus.org.
Jun 11, 2002
Jun 11, 2002
119
120
Aug 30, 2002
Aug 30, 2002
121
OS/2:
Mar 11, 2007
Mar 11, 2007
122
Mar 12, 2007
Mar 12, 2007
123
124
You need Innotek GCC and libc installed (or kLIBC). I tried this on a stock
Warp 4 install, no fixpaks. You need to install link386.exe (Selective
Apr 3, 2007
Apr 3, 2007
125
Install, "link object modules" option). Once klibc and GCC are installed
Mar 12, 2007
Mar 12, 2007
126
correctly, unpack the source to PhysicsFS and run the script
Mar 11, 2007
Mar 11, 2007
127
file "makeos2.cmd". I know this isn't ideal, but I wanted to have this build
Apr 3, 2007
Apr 3, 2007
128
without users having to hunt down a "make" program.
Mar 11, 2007
Mar 11, 2007
129
Apr 3, 2007
Apr 3, 2007
130
131
Someone please port CMake to OS/2. Ideally I'd like to be able to target
Innotek GCC and OpenWatcom with CMake.
Aug 30, 2002
Aug 30, 2002
132
133
If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
Mar 11, 2007
Mar 11, 2007
134
135
OS/2, I'd like to hear from you; send an email to icculus@icculus.org.
Aug 30, 2002
Aug 30, 2002
136
Jun 11, 2002
Jun 11, 2002
137
Apr 6, 2002
Apr 6, 2002
138
OTHER PLATFORMS:
Mar 11, 2007
Mar 11, 2007
139
140
141
142
143
144
145
146
Many Unix-like platforms might "just work" with CMake. Some of these platforms
are known to have worked at one time, but have not been heavily tested, if
tested at all. PhysicsFS is, as far as we know, 64-bit and byteorder clean,
and is known to compile on several compilers across many platforms. To
implement a new platform or archiver, please read the heavily-commented
physfs_internal.h and look in the platform/ and archiver/ directories for
examples.
Apr 6, 2002
Apr 6, 2002
147
Jan 1, 2006
Jan 1, 2006
148
--ryan. (icculus@icculus.org)