annotate README.TXT @ 22:d9f79436e0af default tip

Makefile Add ranlib for the library
author darius
date Fri, 24 Apr 1998 08:05:26 +0000
parents d4366a861859
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
d4366a861859 Initial revision
darius
parents:
diff changeset
1
d4366a861859 Initial revision
darius
parents:
diff changeset
2 --> MikMod Sound Libraries Version 3.0
d4366a861859 Initial revision
darius
parents:
diff changeset
3 -> Release Notes - August 20th, 1997
d4366a861859 Initial revision
darius
parents:
diff changeset
4
d4366a861859 Initial revision
darius
parents:
diff changeset
5
d4366a861859 Initial revision
darius
parents:
diff changeset
6 Welcome to the long awaited MikMod 3.0 public release. Although this
d4366a861859 Initial revision
darius
parents:
diff changeset
7 product has been delayed countless times, hopefully it will be worth
d4366a861859 Initial revision
darius
parents:
diff changeset
8 the wait. We have added tons of new features and worked weeks on end
d4366a861859 Initial revision
darius
parents:
diff changeset
9 to trace down all know bugs.
d4366a861859 Initial revision
darius
parents:
diff changeset
10
d4366a861859 Initial revision
darius
parents:
diff changeset
11 Notes about this release:
d4366a861859 Initial revision
darius
parents:
diff changeset
12
d4366a861859 Initial revision
darius
parents:
diff changeset
13 The documentation is there, but is not finished.
d4366a861859 Initial revision
darius
parents:
diff changeset
14
d4366a861859 Initial revision
darius
parents:
diff changeset
15 Streaming audio has been promised, but it is not functional in this
d4366a861859 Initial revision
darius
parents:
diff changeset
16 version of MikMod. I promise that a 3.xx update will be released
d4366a861859 Initial revision
darius
parents:
diff changeset
17 prety soon that will have support for streaming audio.
d4366a861859 Initial revision
darius
parents:
diff changeset
18
d4366a861859 Initial revision
darius
parents:
diff changeset
19 The Unix side of things is pretty messy. If you want Unix drivers
d4366a861859 Initial revision
darius
parents:
diff changeset
20 for your particular platform, ask me about it! I have a handful of
d4366a861859 Initial revision
darius
parents:
diff changeset
21 partially converted drivers and it just might help save you time
d4366a861859 Initial revision
darius
parents:
diff changeset
22 rather than hack from 2.10 by yourself.
d4366a861859 Initial revision
darius
parents:
diff changeset
23
d4366a861859 Initial revision
darius
parents:
diff changeset
24 VIRTCH2.C, the high-quality mixer used for the WAV and RAW drivers,
d4366a861859 Initial revision
darius
parents:
diff changeset
25 currently requires that your compiler supports 64 bit integers.
d4366a861859 Initial revision
darius
parents:
diff changeset
26 If it does not, ignore VIRTCH2.C and switch drv_raw.c and drv_wav.c
d4366a861859 Initial revision
darius
parents:
diff changeset
27 back to VIRTCH.C. I will have a floating point alternative to the
d4366a861859 Initial revision
darius
parents:
diff changeset
28 64 bit integer VIRTCH2.C very soon.
d4366a861859 Initial revision
darius
parents:
diff changeset
29
d4366a861859 Initial revision
darius
parents:
diff changeset
30 And as usual, please report all bugs to Jake Stine at:
d4366a861859 Initial revision
darius
parents:
diff changeset
31 dracoirs@epix.net.
d4366a861859 Initial revision
darius
parents:
diff changeset
32
d4366a861859 Initial revision
darius
parents:
diff changeset
33
d4366a861859 Initial revision
darius
parents:
diff changeset
34 -/- Compiling for Watcom
d4366a861859 Initial revision
darius
parents:
diff changeset
35
d4366a861859 Initial revision
darius
parents:
diff changeset
36 If you have Watcom for DOS only (no IDE), you should be able to compile
d4366a861859 Initial revision
darius
parents:
diff changeset
37 MIKMOD.EXE in the Examples/ directory by running WCMAKE.BAT. The in-
d4366a861859 Initial revision
darius
parents:
diff changeset
38 dividual makefiles are in the three source trees as MAKEFILE.WC.
d4366a861859 Initial revision
darius
parents:
diff changeset
39
d4366a861859 Initial revision
darius
parents:
diff changeset
40 Users of the IDE (v10.6 or better) can hopefully use the mikmod.wpj lo-
d4366a861859 Initial revision
darius
parents:
diff changeset
41 cated in root directory (same location as this file). MIKMOD.WPJ can
d4366a861859 Initial revision
darius
parents:
diff changeset
42 compile all of the Watcom examples. Or you can make your own project
d4366a861859 Initial revision
darius
parents:
diff changeset
43 and include the MIKMOD.TGT, MMIO.TGT, and EXTDOS.TGT files found in
d4366a861859 Initial revision
darius
parents:
diff changeset
44 the Lib/ directory.
d4366a861859 Initial revision
darius
parents:
diff changeset
45
d4366a861859 Initial revision
darius
parents:
diff changeset
46 Remember that if you are going to be running code from interrupt-driven
d4366a861859 Initial revision
darius
parents:
diff changeset
47 situations (ie, from the system timer), you have to use Watcom's /ZU
d4366a861859 Initial revision
darius
parents:
diff changeset
48 compiler option for any module that will have code called while in an
d4366a861859 Initial revision
darius
parents:
diff changeset
49 interrupt.
d4366a861859 Initial revision
darius
parents:
diff changeset
50
d4366a861859 Initial revision
darius
parents:
diff changeset
51
d4366a861859 Initial revision
darius
parents:
diff changeset
52 -/- Compiling for DJGPP
d4366a861859 Initial revision
darius
parents:
diff changeset
53
d4366a861859 Initial revision
darius
parents:
diff changeset
54 Working DJGPP makefiles have been included as MAKEFILE.GCC in each of
d4366a861859 Initial revision
darius
parents:
diff changeset
55 the source trees. MikMod now works 100% with DJGPP version 2.0 and
d4366a861859 Initial revision
darius
parents:
diff changeset
56 above.
d4366a861859 Initial revision
darius
parents:
diff changeset
57
d4366a861859 Initial revision
darius
parents:
diff changeset
58
d4366a861859 Initial revision
darius
parents:
diff changeset
59 -/- Other Compilers
d4366a861859 Initial revision
darius
parents:
diff changeset
60
d4366a861859 Initial revision
darius
parents:
diff changeset
61 If you have another compiler and you manage to get Mikmod to work with
d4366a861859 Initial revision
darius
parents:
diff changeset
62 it, drop me a line and we will see about making the needed changes to
d4366a861859 Initial revision
darius
parents:
diff changeset
63 my copy for the next release.
d4366a861859 Initial revision
darius
parents:
diff changeset
64
d4366a861859 Initial revision
darius
parents:
diff changeset
65 If you get into trouble, you can e-mail me for help. Otherwise, make
d4366a861859 Initial revision
darius
parents:
diff changeset
66 sure to check the example files for general useage and some other misc-
d4366a861859 Initial revision
darius
parents:
diff changeset
67 ellaneous information.
d4366a861859 Initial revision
darius
parents:
diff changeset
68
d4366a861859 Initial revision
darius
parents:
diff changeset
69
d4366a861859 Initial revision
darius
parents:
diff changeset
70
d4366a861859 Initial revision
darius
parents:
diff changeset
71 Documentation
d4366a861859 Initial revision
darius
parents:
diff changeset
72 =============
d4366a861859 Initial revision
darius
parents:
diff changeset
73
d4366a861859 Initial revision
darius
parents:
diff changeset
74 There are several documentation files in the Docs/ directory. They are:
d4366a861859 Initial revision
darius
parents:
diff changeset
75
d4366a861859 Initial revision
darius
parents:
diff changeset
76 MIKMOD.DOC: General and specific useage of the MikMod Sound System in
d4366a861859 Initial revision
darius
parents:
diff changeset
77 programs. Contains a reference to all API calls, global
d4366a861859 Initial revision
darius
parents:
diff changeset
78 variables, and soundcards supported.
d4366a861859 Initial revision
darius
parents:
diff changeset
79
d4366a861859 Initial revision
darius
parents:
diff changeset
80 This file is in Microsoft Word fr Windows 2.0 format. If
d4366a861859 Initial revision
darius
parents:
diff changeset
81 you do not have a program to read this format, you can
d4366a861859 Initial revision
darius
parents:
diff changeset
82 download a free Word viewer from [assuming Microsoft does
d4366a861859 Initial revision
darius
parents:
diff changeset
83 not rearrange their site (yea, right)]:
d4366a861859 Initial revision
darius
parents:
diff changeset
84
d4366a861859 Initial revision
darius
parents:
diff changeset
85 http://www.microsoft.com/officefreestuff/word/
d4366a861859 Initial revision
darius
parents:
diff changeset
86
d4366a861859 Initial revision
darius
parents:
diff changeset
87 MIKCVT.TXT: Text file on how to use the MIKCVT.EXE conversion utility.
d4366a861859 Initial revision
darius
parents:
diff changeset
88
d4366a861859 Initial revision
darius
parents:
diff changeset
89 TIPS.TXT: Various tips, tricks, and optimizations that I jot down as
d4366a861859 Initial revision
darius
parents:
diff changeset
90 I think of them.
d4366a861859 Initial revision
darius
parents:
diff changeset
91
d4366a861859 Initial revision
darius
parents:
diff changeset
92
d4366a861859 Initial revision
darius
parents:
diff changeset
93
d4366a861859 Initial revision
darius
parents:
diff changeset
94 Example sources
d4366a861859 Initial revision
darius
parents:
diff changeset
95 ===============
d4366a861859 Initial revision
darius
parents:
diff changeset
96
d4366a861859 Initial revision
darius
parents:
diff changeset
97 This version of MikMod includes four sample sources:
d4366a861859 Initial revision
darius
parents:
diff changeset
98
d4366a861859 Initial revision
darius
parents:
diff changeset
99 MIKMOD: A basic module player with a simple interface.
d4366a861859 Initial revision
darius
parents:
diff changeset
100
d4366a861859 Initial revision
darius
parents:
diff changeset
101 MIKWAV: An example of WAV loading and sound effects usage.
d4366a861859 Initial revision
darius
parents:
diff changeset
102 This example includes the three wave files also included,
d4366a861859 Initial revision
darius
parents:
diff changeset
103 EXPLODE.WAV, MECHA.WAV, and SLASH.WAV.
d4366a861859 Initial revision
darius
parents:
diff changeset
104
d4366a861859 Initial revision
darius
parents:
diff changeset
105 MIKINTER: A simplified module player which attaches MikMod_Update()
d4366a861859 Initial revision
darius
parents:
diff changeset
106 to the timer interrupt, which is convienient for games
d4366a861859 Initial revision
darius
parents:
diff changeset
107 and demos (MS-DOS only).
d4366a861859 Initial revision
darius
parents:
diff changeset
108
d4366a861859 Initial revision
darius
parents:
diff changeset
109 MIKCVT: A conversion utility to convert all types of supported mod-
d4366a861859 Initial revision
darius
parents:
diff changeset
110 ules to MikMod's internal UniFormat. See docs\mikcvt.txt for
d4366a861859 Initial revision
darius
parents:
diff changeset
111 more useage informaion.
d4366a861859 Initial revision
darius
parents:
diff changeset
112
d4366a861859 Initial revision
darius
parents:
diff changeset
113
d4366a861859 Initial revision
darius
parents:
diff changeset
114
d4366a861859 Initial revision
darius
parents:
diff changeset
115
d4366a861859 Initial revision
darius
parents:
diff changeset
116 How to contact us
d4366a861859 Initial revision
darius
parents:
diff changeset
117 =================
d4366a861859 Initial revision
darius
parents:
diff changeset
118
d4366a861859 Initial revision
darius
parents:
diff changeset
119 Please send your questions, registration forms, comments, bugreports,
d4366a861859 Initial revision
darius
parents:
diff changeset
120 bugfixes, loaders, drivers, soundcards etc. to:
d4366a861859 Initial revision
darius
parents:
diff changeset
121
d4366a861859 Initial revision
darius
parents:
diff changeset
122
d4366a861859 Initial revision
darius
parents:
diff changeset
123 -/- Jake Stine [Air Richter]
d4366a861859 Initial revision
darius
parents:
diff changeset
124
d4366a861859 Initial revision
darius
parents:
diff changeset
125 Email:
d4366a861859 Initial revision
darius
parents:
diff changeset
126 dracoirs@epix.net (preferred)
d4366a861859 Initial revision
darius
parents:
diff changeset
127 dkstine@microserve.com
d4366a861859 Initial revision
darius
parents:
diff changeset
128
d4366a861859 Initial revision
darius
parents:
diff changeset
129 Snail-mail:
d4366a861859 Initial revision
darius
parents:
diff changeset
130 Jake Stine
d4366a861859 Initial revision
darius
parents:
diff changeset
131 2970 Laurel Run Road
d4366a861859 Initial revision
darius
parents:
diff changeset
132 Wilkes-Barre, PA 18702
d4366a861859 Initial revision
darius
parents:
diff changeset
133 United States
d4366a861859 Initial revision
darius
parents:
diff changeset
134
d4366a861859 Initial revision
darius
parents:
diff changeset
135 Phone:
d4366a861859 Initial revision
darius
parents:
diff changeset
136 (717) 822-2794
d4366a861859 Initial revision
darius
parents:
diff changeset
137
d4366a861859 Initial revision
darius
parents:
diff changeset
138
d4366a861859 Initial revision
darius
parents:
diff changeset
139 And if you want to contact MikMak, the original author of MikMod:
d4366a861859 Initial revision
darius
parents:
diff changeset
140
d4366a861859 Initial revision
darius
parents:
diff changeset
141 -/- Jean-Paul Mikkers [MikMak]
d4366a861859 Initial revision
darius
parents:
diff changeset
142
d4366a861859 Initial revision
darius
parents:
diff changeset
143 Email:
d4366a861859 Initial revision
darius
parents:
diff changeset
144 mikmak@via.nl (preferred)
d4366a861859 Initial revision
darius
parents:
diff changeset
145 mikmak@stack.urc.tue.nl
d4366a861859 Initial revision
darius
parents:
diff changeset
146
d4366a861859 Initial revision
darius
parents:
diff changeset
147
d4366a861859 Initial revision
darius
parents:
diff changeset
148 Snail-mail:
d4366a861859 Initial revision
darius
parents:
diff changeset
149 Jean-Paul Mikkers
d4366a861859 Initial revision
darius
parents:
diff changeset
150 Godartstr. 16
d4366a861859 Initial revision
darius
parents:
diff changeset
151 5932AX Tegelen,
d4366a861859 Initial revision
darius
parents:
diff changeset
152 The Netherlands
d4366a861859 Initial revision
darius
parents:
diff changeset
153
d4366a861859 Initial revision
darius
parents:
diff changeset
154 Phone:
d4366a861859 Initial revision
darius
parents:
diff changeset
155 +31 (0)77-3732736
d4366a861859 Initial revision
darius
parents:
diff changeset
156
d4366a861859 Initial revision
darius
parents:
diff changeset
157
d4366a861859 Initial revision
darius
parents:
diff changeset
158
d4366a861859 Initial revision
darius
parents:
diff changeset
159 Legal Stuff
d4366a861859 Initial revision
darius
parents:
diff changeset
160 ===========
d4366a861859 Initial revision
darius
parents:
diff changeset
161
d4366a861859 Initial revision
darius
parents:
diff changeset
162 MikMod has been released under a special liscencing agreement. This
d4366a861859 Initial revision
darius
parents:
diff changeset
163 software package is free to use for home and educational purposes only,
d4366a861859 Initial revision
darius
parents:
diff changeset
164 and all users are permitted to redistribute the software in its complete
d4366a861859 Initial revision
darius
parents:
diff changeset
165 and original form only. Unregistered use of this software in a com-
d4366a861859 Initial revision
darius
parents:
diff changeset
166 mercial package or program is prohibited. Basic translation: IF YOU ARE
d4366a861859 Initial revision
darius
parents:
diff changeset
167 ASKING MONEY FOR THE PRODUCT YOU USE THIS SOFTWARE WITH, YOU HAVE TO
d4366a861859 Initial revision
darius
parents:
diff changeset
168 REGISTER! Please see Registration Instructions below for information on
d4366a861859 Initial revision
darius
parents:
diff changeset
169 how to register.
d4366a861859 Initial revision
darius
parents:
diff changeset
170
d4366a861859 Initial revision
darius
parents:
diff changeset
171 - Registration is only $40 US dollars.
d4366a861859 Initial revision
darius
parents:
diff changeset
172
d4366a861859 Initial revision
darius
parents:
diff changeset
173 - Registering is for the distribution rights of binaries only. Com-
d4366a861859 Initial revision
darius
parents:
diff changeset
174 mercial distribution of the sources or portions of the sources in
d4366a861859 Initial revision
darius
parents:
diff changeset
175 any form is strictly prohibited without special granted permission
d4366a861859 Initial revision
darius
parents:
diff changeset
176 from Divine Entertainment.
d4366a861859 Initial revision
darius
parents:
diff changeset
177
d4366a861859 Initial revision
darius
parents:
diff changeset
178 - Registering MikMod gives you the right to sell an unlimited number of
d4366a861859 Initial revision
darius
parents:
diff changeset
179 copies of the product you're using it for.. pretty flexible huh?
d4366a861859 Initial revision
darius
parents:
diff changeset
180
d4366a861859 Initial revision
darius
parents:
diff changeset
181 - Registering is good for all minor versions under the current major
d4366a861859 Initial revision
darius
parents:
diff changeset
182 version. For example, if you register for MikMod 3.00 now, all possi-
d4366a861859 Initial revision
darius
parents:
diff changeset
183 ble updates through 3.99 will also be registered. This allows for
d4366a861859 Initial revision
darius
parents:
diff changeset
184 bugfixes and updates without the need to register again.
d4366a861859 Initial revision
darius
parents:
diff changeset
185
d4366a861859 Initial revision
darius
parents:
diff changeset
186 - A MikMod registration cannot be transferred from one person to another,
d4366a861859 Initial revision
darius
parents:
diff changeset
187 or from one person to a company, or from one company to another company.
d4366a861859 Initial revision
darius
parents:
diff changeset
188
d4366a861859 Initial revision
darius
parents:
diff changeset
189 - Contributors to a library (bug-fixes, new code) will get automatic
d4366a861859 Initial revision
darius
parents:
diff changeset
190 registration for all future versions. Divine Entertainment reserves
d4366a861859 Initial revision
darius
parents:
diff changeset
191 the right to decide if your contribution is good enough for registra-
d4366a861859 Initial revision
darius
parents:
diff changeset
192 tion.
d4366a861859 Initial revision
darius
parents:
diff changeset
193
d4366a861859 Initial revision
darius
parents:
diff changeset
194 - Registered users will be optionally added to a mailing list.
d4366a861859 Initial revision
darius
parents:
diff changeset
195
d4366a861859 Initial revision
darius
parents:
diff changeset
196 - If you use MikMod on a regular basis for home or educational use, we
d4366a861859 Initial revision
darius
parents:
diff changeset
197 encourage you to register to help support the product (although you
d4366a861859 Initial revision
darius
parents:
diff changeset
198 do not have to).
d4366a861859 Initial revision
darius
parents:
diff changeset
199
d4366a861859 Initial revision
darius
parents:
diff changeset
200 - If you have any questions concerning registration, mail your query to
d4366a861859 Initial revision
darius
parents:
diff changeset
201 dracoirs@epix.net.
d4366a861859 Initial revision
darius
parents:
diff changeset
202
d4366a861859 Initial revision
darius
parents:
diff changeset
203
d4366a861859 Initial revision
darius
parents:
diff changeset
204 Disclaimer:
d4366a861859 Initial revision
darius
parents:
diff changeset
205
d4366a861859 Initial revision
darius
parents:
diff changeset
206 The author (Jake Stine) specifically disclaims all warranties, expressed
d4366a861859 Initial revision
darius
parents:
diff changeset
207 or implied, including but not limited to implied warranties of merchant-
d4366a861859 Initial revision
darius
parents:
diff changeset
208 ability and fitness for a particular purpose with respect to defects in
d4366a861859 Initial revision
darius
parents:
diff changeset
209 the software and documentation.
d4366a861859 Initial revision
darius
parents:
diff changeset
210
d4366a861859 Initial revision
darius
parents:
diff changeset
211 In no event shall the author be liable for any loss of profit or damage,
d4366a861859 Initial revision
darius
parents:
diff changeset
212 including but not limited to special, incidental, or consequential
d4366a861859 Initial revision
darius
parents:
diff changeset
213 damages.
d4366a861859 Initial revision
darius
parents:
diff changeset
214
d4366a861859 Initial revision
darius
parents:
diff changeset
215 All product names, trademarks and registered trademarks contained in this
d4366a861859 Initial revision
darius
parents:
diff changeset
216 document are the property of their respective holders.
d4366a861859 Initial revision
darius
parents:
diff changeset
217