annotate docs/mikcvt.txt @ 6:d14fd386d182

Initial entry of mikmod into the CVS tree.
author darius
date Fri, 23 Jan 1998 16:05:09 +0000
parents 5d614bcc4287
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
1
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
2 --> MikMod Sound System v3.0
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
3 -> UniFormat Conversion Program (MIKCVT.EXE)
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
4
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
5
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
6
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
7 -/- Introduction
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
8 ================
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
9
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
10 MikMod utilizes its own internal format called UniMod (or UniFormat).
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
11 This internal format can 100% accurately represent any of the modules
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
12 that MikMod supports. The advantage of UniMod is that the programmer
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
13 can convert all modules of any type to this native MikMod format, and
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
14 simply include the UniMod loader alone into the program.
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
15
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
16 For more information about UniMod, see UNIMOD30.TXT.
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
17
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
18 MikMod comes with a program called MIKCVT.EXE, which converts modules
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
19 to the UniMod format. MIKCVT will load any module supported by
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
20 MikMod, optimize and compress the pattern data, and save out a file
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
21 with the .UNI extension. MIKCVT also supports wildcards, so that you
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
22 can easily convert several modules at a time.
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
23
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
24
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
25 -/- Distribution
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
26 ================
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
27
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
28 MIKCVT is a totally free utility, and can be downloaded separately
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
29 from MikMod. MIKCVT comes with full source code, and the programmer
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
30 can feel free to modify this source code in any way for PERSONAL use
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
31 only (to rearrange the format to prevent module ripping for instance).
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
32 PLEASE DO NOT REDISTRIBUTE A MODIFIED VERSION OF MIKCVT. The last
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
33 thing anyone wants is to have odd non-std versions of UniMod modules
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
34 floating around.
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
35
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
36
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
37
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
38 -/- Usage
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
39 =========
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
40
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
41 MIKCVT has a very simple command line interface, as follows:
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
42
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
43 MIKCVT [-strip] infile [infile] [infile] ...
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
44
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
45 MIKCVT song1.s3m song2.xm
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
46 MIKCVT -strip *.s3m
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
47 MIKCVT *.*
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
48
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
49 The first example shows the general syntax of MIKCVT. Note that
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
50 -strip is optional, but if present MUST be the first option on
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
51 the command line.
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
52
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
53 In any instance, the -strip is optional, and if present will tell
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
54 MIKCVT to remove all text strings from the module. This includes
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
55 the title, sample names, instrument names, comments and other forms
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
56 of text. This feature is generally intended for use by game and demo
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
57 developers, who may not require such information in the release pro-
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
58 duct.
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
59
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
60
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
61 -/- Miscellaneous
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
62 =================
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
63
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
64 There will probably be a future version of MIKCVT that will further
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
65 optimize modules in -strip mode.
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
66
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
67 For information, questions, comments, or various chit-chat, contact
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
68 Jake Stine / Divine Entertainment at jstine@hotmail.com.
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
69
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
70 For updates and other updated information, check out the Divine Ent-
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
71 ertainment website at http://www.epix.net/~dracoirs/
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
72
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
73
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
74 That's all for today. Have fun!
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
75
5d614bcc4287 Initial entry of mikmod into the CVS tree.
darius
parents:
diff changeset
76