Skip to content

Latest commit

 

History

History
141 lines (89 loc) · 5.19 KB

INSTALL.txt

File metadata and controls

141 lines (89 loc) · 5.19 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
You will need CMake (http://www.cmake.org/) 2.4 or later installed.
Mar 23, 2009
Mar 23, 2009
29
30
31
32
33
34
Make a directory, wherever you like. This will be your build directory.
Chdir to your build directory. Run "cmake /where/i/unpacked/physfs" 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.
Mar 11, 2007
Mar 11, 2007
35
36
Run "make". PhysicsFS will now build.
Jul 28, 2001
Jul 28, 2001
37
May 24, 2002
May 24, 2002
38
As root, run "make install".
Mar 11, 2007
Mar 11, 2007
39
40
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
41
Mar 23, 2009
Mar 23, 2009
42
43
Once you are satisfied, you can delete the build directory.
Aug 30, 2002
Aug 30, 2002
44
Primary Unix development is done with GNU/Linux, but PhysicsFS is known to
Mar 11, 2007
Mar 11, 2007
45
46
47
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
48
49
Mar 23, 2009
Mar 23, 2009
50
BeOS, Zeta, and Haiku:
Mar 11, 2007
Mar 11, 2007
51
52
Use the "Unix" instructions, above. The CMake port to BeOS is fairly new at
Apr 3, 2007
Apr 3, 2007
53
54
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
55
56
57
Mar 11, 2007
Mar 11, 2007
58
Windows:
Aug 23, 2001
Aug 23, 2001
59
Mar 23, 2009
Mar 23, 2009
60
If building with Cygwin, mingw32, MSYS, or something else that uses the GNU
Mar 11, 2007
Mar 11, 2007
61
toolchain, follow the Unix instructions, above.
Jun 11, 2002
Jun 11, 2002
62
Mar 11, 2007
Mar 11, 2007
63
64
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
65
66
67
68
69
70
71
72
73
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
74
Mar 11, 2007
Mar 11, 2007
75
76
77
78
79
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
80
Jan 16, 2014
Jan 16, 2014
81
PhysicsFS works on 32-bit and 64-bit Windows. There is no 16-bit Windows
Mar 12, 2012
Mar 12, 2012
82
83
support at all. Reports of success and problems can go to Ryan at
icculus@icculus.org ...
Jun 11, 2002
Jun 11, 2002
84
Mar 11, 2007
Mar 11, 2007
85
86
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
87
Apr 24, 2002
Apr 24, 2002
88
Mar 11, 2007
Mar 11, 2007
89
90
PocketPC/WindowsCE:
Mar 9, 2012
Mar 9, 2012
91
92
93
94
Support for PocketPC was removed in PhysicsFS 2.1.0. This was known to work
in the 1.0 releases, but wasn't tested in 2.0 and later. PhysicsFS is not
known to work on Windows Phone 7 (the latest Microsoft mobile tech at the
time of this writing).
Mar 11, 2007
Mar 11, 2007
95
96
97
MAC OS 8/9:
Sep 2, 2001
Sep 2, 2001
98
Mar 14, 2007
Mar 14, 2007
99
Classic Mac OS support has been dropped in PhysicsFS 2.0. Apple hasn't updated
Mar 23, 2009
Mar 23, 2009
100
pre-OSX versions in more than a decade at this point, none of the hardware
Mar 14, 2007
Mar 14, 2007
101
102
103
104
105
106
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
107
108
Apr 6, 2002
Apr 6, 2002
109
Mar 11, 2007
Mar 11, 2007
110
MAC OS X:
Apr 6, 2002
Apr 6, 2002
111
Mar 11, 2007
Mar 11, 2007
112
You will need CMake (http://www.cmake.org/) 2.4 or later installed.
Jun 11, 2002
Jun 11, 2002
113
Mar 11, 2007
Mar 11, 2007
114
115
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
116
Mar 11, 2007
Mar 11, 2007
117
PowerPC and Intel Macs should both be supported.
Jun 11, 2002
Jun 11, 2002
118
119
If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
Mar 11, 2007
Mar 11, 2007
120
121
Mac OS X, I'd like to hear from you; send an email to icculus@icculus.org.
Jun 11, 2002
Jun 11, 2002
122
123
Aug 30, 2002
Aug 30, 2002
124
OS/2:
Mar 11, 2007
Mar 11, 2007
125
Jan 16, 2014
Jan 16, 2014
126
127
Support for OS/2 was removed in PhysicsFS 2.1. PhysicsFS 2.0 can still target
this platform.
Aug 30, 2002
Aug 30, 2002
128
Jun 11, 2002
Jun 11, 2002
129
Apr 6, 2002
Apr 6, 2002
130
OTHER PLATFORMS:
Mar 11, 2007
Mar 11, 2007
131
132
133
134
135
136
137
138
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
139
Jan 1, 2006
Jan 1, 2006
140
--ryan. (icculus@icculus.org)