comparison docs/mikcvt.txt @ 4:5d614bcc4287

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