Mercurial > ~darius > hgwebdir.cgi > mikmod

comparison README.TXT @ 1:d4366a861859

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