Skip to content

Latest commit

 

History

History
142 lines (87 loc) · 5.06 KB

INSTALL.txt

File metadata and controls

142 lines (87 loc) · 5.06 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
49
Use the "Unix" instructions, above. The CMake port to BeOS is fairly new at
the time of this writing, but it works. You can get it from bebits.com ...
Aug 30, 2002
Aug 30, 2002
50
51
52
Mar 11, 2007
Mar 11, 2007
53
Windows:
Aug 23, 2001
Aug 23, 2001
54
Jun 11, 2002
Jun 11, 2002
55
If building with CygWin, mingw32 or something else that uses the GNU
Mar 11, 2007
Mar 11, 2007
56
toolchain, follow the Unix instructions, above.
Jun 11, 2002
Jun 11, 2002
57
Mar 11, 2007
Mar 11, 2007
58
59
60
61
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
CMakeLists.txt file in the root of the source directory and it will generate
project files for you.
Jun 11, 2002
Jun 11, 2002
62
Mar 11, 2007
Mar 11, 2007
63
64
65
66
67
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
68
Mar 11, 2007
Mar 11, 2007
69
70
71
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
72
Mar 11, 2007
Mar 11, 2007
73
74
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
75
Apr 24, 2002
Apr 24, 2002
76
77
Mar 11, 2007
Mar 11, 2007
78
79
80
81
82
83
84
85
86
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
87
Mar 14, 2007
Mar 14, 2007
88
89
90
91
92
93
94
95
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
96
97
Apr 6, 2002
Apr 6, 2002
98
Mar 11, 2007
Mar 11, 2007
99
MAC OS X:
Apr 6, 2002
Apr 6, 2002
100
Mar 11, 2007
Mar 11, 2007
101
You will need CMake (http://www.cmake.org/) 2.4 or later installed.
Jun 11, 2002
Jun 11, 2002
102
Mar 11, 2007
Mar 11, 2007
103
104
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
105
Mar 11, 2007
Mar 11, 2007
106
PowerPC and Intel Macs should both be supported.
Jun 11, 2002
Jun 11, 2002
107
108
If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
Mar 11, 2007
Mar 11, 2007
109
110
Mac OS X, I'd like to hear from you; send an email to icculus@icculus.org.
Jun 11, 2002
Jun 11, 2002
111
112
Aug 30, 2002
Aug 30, 2002
113
OS/2:
Mar 11, 2007
Mar 11, 2007
114
Mar 12, 2007
Mar 12, 2007
115
116
117
118
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
Install, "link object modules" option). Once libc and GCC are installed
correctly, unpack the source to PhysicsFS and run the script
Mar 11, 2007
Mar 11, 2007
119
120
121
122
123
file "makeos2.cmd". I know this isn't ideal, but I wanted to have this build
without users having to hunt down a "make" program (While several exist, EMX
doesn't come with one). If someone wants to hack some REXX to make this a bit
more picky about recompiling, I'll accept the patch.
Mar 12, 2007
Mar 12, 2007
124
Someone please port CMake to OS/2.
Aug 30, 2002
Aug 30, 2002
125
126
If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
Mar 11, 2007
Mar 11, 2007
127
128
OS/2, I'd like to hear from you; send an email to icculus@icculus.org.
Aug 30, 2002
Aug 30, 2002
129
Jun 11, 2002
Jun 11, 2002
130
Apr 6, 2002
Apr 6, 2002
131
OTHER PLATFORMS:
Mar 11, 2007
Mar 11, 2007
132
133
134
135
136
137
138
139
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
140
Jan 1, 2006
Jan 1, 2006
141
--ryan. (icculus@icculus.org)