annotate README.LINUX @ 6:d14fd386d182

Initial entry of mikmod into the CVS tree.
author darius
date Fri, 23 Jan 1998 16:05:09 +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 FOR UNIX --------------+
d4366a861859 Initial revision
darius
parents:
diff changeset
3 \----------------------------------------------/
d4366a861859 Initial revision
darius
parents:
diff changeset
4
d4366a861859 Initial revision
darius
parents:
diff changeset
5 This is version 3.0.1 of MikMod of Unix - it is a fairly big leap
d4366a861859 Initial revision
darius
parents:
diff changeset
6 from the MikMod 2.14 that everyone's been using for the past year or
d4366a861859 Initial revision
darius
parents:
diff changeset
7 so - sorry it's so late coming. However, I think you'll be pleased
d4366a861859 Initial revision
darius
parents:
diff changeset
8 with it... The console player is better - you can see
d4366a861859 Initial revision
darius
parents:
diff changeset
9 & scroll through the instrument list and see the sample messages now,
d4366a861859 Initial revision
darius
parents:
diff changeset
10 and the archive support is much improved, and the playlist support is
d4366a861859 Initial revision
darius
parents:
diff changeset
11 pretty sweet as well. The big thing really is...
d4366a861859 Initial revision
darius
parents:
diff changeset
12
d4366a861859 Initial revision
darius
parents:
diff changeset
13 WE HAVE IMPULSE TRACKER SUPPORT!!!!!!!!!!!!!!!!!!!!!!!!
d4366a861859 Initial revision
darius
parents:
diff changeset
14
d4366a861859 Initial revision
darius
parents:
diff changeset
15 This now puts MikMod 3.0 in direct competition with MikIT :)
d4366a861859 Initial revision
darius
parents:
diff changeset
16
d4366a861859 Initial revision
darius
parents:
diff changeset
17
d4366a861859 Initial revision
darius
parents:
diff changeset
18 COMPILING
d4366a861859 Initial revision
darius
parents:
diff changeset
19
d4366a861859 Initial revision
darius
parents:
diff changeset
20 I. Type "build-mikmod.sh"
d4366a861859 Initial revision
darius
parents:
diff changeset
21 II. It builds
d4366a861859 Initial revision
darius
parents:
diff changeset
22 III. The excutable binary 'mikmod' is spit into your directory
d4366a861859 Initial revision
darius
parents:
diff changeset
23 IV. Install mikmod somewhere in your $PATH
d4366a861859 Initial revision
darius
parents:
diff changeset
24 V. Enjoy kick-ass mod music :)
d4366a861859 Initial revision
darius
parents:
diff changeset
25
d4366a861859 Initial revision
darius
parents:
diff changeset
26
d4366a861859 Initial revision
darius
parents:
diff changeset
27 USING MIKMOD
d4366a861859 Initial revision
darius
parents:
diff changeset
28
d4366a861859 Initial revision
darius
parents:
diff changeset
29 To get the command line options, type "mikmod -h"
d4366a861859 Initial revision
darius
parents:
diff changeset
30 That should tell you most of what you want to know, basically you just
d4366a861859 Initial revision
darius
parents:
diff changeset
31 type "mikmod <filename-1> <filename-2> ... <filename-n>"
d4366a861859 Initial revision
darius
parents:
diff changeset
32 Once you're in the player, a few keys you can press...
d4366a861859 Initial revision
darius
parents:
diff changeset
33 (keys don't have to be capitalized, BTW)
d4366a861859 Initial revision
darius
parents:
diff changeset
34
d4366a861859 Initial revision
darius
parents:
diff changeset
35 UP/DOWN scrolls the sample list
d4366a861859 Initial revision
darius
parents:
diff changeset
36 LEFT/RIGHT or -/+ moves the song backwards/forwards 1 pattern
d4366a861859 Initial revision
darius
parents:
diff changeset
37 SPACE pauses
d4366a861859 Initial revision
darius
parents:
diff changeset
38 N loads the next song
d4366a861859 Initial revision
darius
parents:
diff changeset
39 P loads the previous song
d4366a861859 Initial revision
darius
parents:
diff changeset
40 Q quits
d4366a861859 Initial revision
darius
parents:
diff changeset
41 W writes writes the current playlist to "$HOME/mikmodplaylist"
d4366a861859 Initial revision
darius
parents:
diff changeset
42 I toggles between sample/instrument names/messages
d4366a861859 Initial revision
darius
parents:
diff changeset
43 (this is only for .XMs and .ITs)
d4366a861859 Initial revision
darius
parents:
diff changeset
44 M gives you the song message/comment (.ITs ONLY)
d4366a861859 Initial revision
darius
parents:
diff changeset
45
d4366a861859 Initial revision
darius
parents:
diff changeset
46 If you're playing MikMod in quiet mode (with the -q switch), you
d4366a861859 Initial revision
darius
parents:
diff changeset
47 can tell MikMod to jump to the next/previous song by sending
d4366a861859 Initial revision
darius
parents:
diff changeset
48 the MikMod process SIGUSR1 or SIGUSR2 respectivly.
d4366a861859 Initial revision
darius
parents:
diff changeset
49 In other words, let's say you're doing something like this:
d4366a861859 Initial revision
darius
parents:
diff changeset
50
d4366a861859 Initial revision
darius
parents:
diff changeset
51 $ mikmod -pl myalltimefavmods -rp -k -t -q &
d4366a861859 Initial revision
darius
parents:
diff changeset
52 [1] 7531
d4366a861859 Initial revision
darius
parents:
diff changeset
53
d4366a861859 Initial revision
darius
parents:
diff changeset
54 You've told MikMod to read the songs out of the playlist
d4366a861859 Initial revision
darius
parents:
diff changeset
55 myalltimefavmods, to play them in random order, to delete each
d4366a861859 Initial revision
darius
parents:
diff changeset
56 module from the playlist after playing (so none get played twice)
d4366a861859 Initial revision
darius
parents:
diff changeset
57 to skip over any file access errors, to not spit out any output, and
d4366a861859 Initial revision
darius
parents:
diff changeset
58 to run in the background.
d4366a861859 Initial revision
darius
parents:
diff changeset
59 bash gives us the process ID, in this case it's 7531. You can also
d4366a861859 Initial revision
darius
parents:
diff changeset
60 find this out from "ps", "top", on any of a number of other utilities.
d4366a861859 Initial revision
darius
parents:
diff changeset
61 Now, let's say a song you don't like as much comes on, or for some
d4366a861859 Initial revision
darius
parents:
diff changeset
62 reason one seems to be looping forever, you can do this...
d4366a861859 Initial revision
darius
parents:
diff changeset
63
d4366a861859 Initial revision
darius
parents:
diff changeset
64 $ kill -s SIGUSR1 7531
d4366a861859 Initial revision
darius
parents:
diff changeset
65
d4366a861859 Initial revision
darius
parents:
diff changeset
66 and MikMod will start playing the next file in the list.
d4366a861859 Initial revision
darius
parents:
diff changeset
67 If you want the previous file, just use SIGUSR2 in place of
d4366a861859 Initial revision
darius
parents:
diff changeset
68 SIGUSR1. Note that when you're playing randomly, it doesn't actually
d4366a861859 Initial revision
darius
parents:
diff changeset
69 make any different if you select next or previous, because the next song
d4366a861859 Initial revision
darius
parents:
diff changeset
70 is selected randomly every time, and the previous one not saved. As
d4366a861859 Initial revision
darius
parents:
diff changeset
71 well, if you're not playing randomly but have an ordered list you are
d4366a861859 Initial revision
darius
parents:
diff changeset
72 deleting after each plays, you won't be able to get the previous song
d4366a861859 Initial revision
darius
parents:
diff changeset
73 played either... Hrm, maybe I should make SIGUSR2 toggle pause
d4366a861859 Initial revision
darius
parents:
diff changeset
74 instead... What do you think? E-mail me!
d4366a861859 Initial revision
darius
parents:
diff changeset
75
d4366a861859 Initial revision
darius
parents:
diff changeset
76
d4366a861859 Initial revision
darius
parents:
diff changeset
77 BUGS
d4366a861859 Initial revision
darius
parents:
diff changeset
78
d4366a861859 Initial revision
darius
parents:
diff changeset
79 What? Bugs? Where???
d4366a861859 Initial revision
darius
parents:
diff changeset
80 Yes, there are a few bugs and/or misfeatures and/or things that should
d4366a861859 Initial revision
darius
parents:
diff changeset
81 be implemented that haven't yet been.
d4366a861859 Initial revision
darius
parents:
diff changeset
82
d4366a861859 Initial revision
darius
parents:
diff changeset
83 - sample messages are sometimes a bit screwed up for some .MTMs
d4366a861859 Initial revision
darius
parents:
diff changeset
84 - You can't view the song messages of .MTMs, except possibly for
d4366a861859 Initial revision
darius
parents:
diff changeset
85 the very first line. This is because the way the song comment
d4366a861859 Initial revision
darius
parents:
diff changeset
86 is stored is really wierd for .MTMs and totally different from
d4366a861859 Initial revision
darius
parents:
diff changeset
87 the way .ITs store it.
d4366a861859 Initial revision
darius
parents:
diff changeset
88 - When you pause, any looped notes will keep on playing. This is
d4366a861859 Initial revision
darius
parents:
diff changeset
89 actually a bug ("feature") of MikMod_TogglePause() which
d4366a861859 Initial revision
darius
parents:
diff changeset
90 I will probably have to do in and patch...
d4366a861859 Initial revision
darius
parents:
diff changeset
91 - At the end of a few songs you'll "go over the edge" and it will
d4366a861859 Initial revision
darius
parents:
diff changeset
92 try to play past the end of the second to last patten. In
d4366a861859 Initial revision
darius
parents:
diff changeset
93 other words, if "pos:" of the ncurses display starts showing
d4366a861859 Initial revision
darius
parents:
diff changeset
94 400+ and the sound is wrong (or not there) it's time to hit
d4366a861859 Initial revision
darius
parents:
diff changeset
95 NEXT...
d4366a861859 Initial revision
darius
parents:
diff changeset
96 - The ULT loader is broken. Segfaults every time... Solution:
d4366a861859 Initial revision
darius
parents:
diff changeset
97 AVOID PLAYING ULTRATRACKER MODS FOR THE TIME BEING
d4366a861859 Initial revision
darius
parents:
diff changeset
98 (it's not so common a format, so that shouldn't be too too
d4366a861859 Initial revision
darius
parents:
diff changeset
99 inconvinient)
d4366a861859 Initial revision
darius
parents:
diff changeset
100 - In addition to .ULT, the .FAR, .MED, and .669 loaders are of
d4366a861859 Initial revision
darius
parents:
diff changeset
101 questionable status. I haven't been able to throw any files
d4366a861859 Initial revision
darius
parents:
diff changeset
102 of such formats at 'em to test. Tell me about your
d4366a861859 Initial revision
darius
parents:
diff changeset
103 successes/failures at playing any of those...
d4366a861859 Initial revision
darius
parents:
diff changeset
104 - Hmm, the status display should probably display the BPM along
d4366a861859 Initial revision
darius
parents:
diff changeset
105 with the protracker speed...
d4366a861859 Initial revision
darius
parents:
diff changeset
106 - Sometimes I've gotten "Cannot allocate DMA buffer" error.
d4366a861859 Initial revision
darius
parents:
diff changeset
107 I don't know where this is comming from, and it can be annoying.
d4366a861859 Initial revision
darius
parents:
diff changeset
108 Try running it a few times and it will work eventually.
d4366a861859 Initial revision
darius
parents:
diff changeset
109 - Prolly some other problems that escape me at the moment...
d4366a861859 Initial revision
darius
parents:
diff changeset
110
d4366a861859 Initial revision
darius
parents:
diff changeset
111
d4366a861859 Initial revision
darius
parents:
diff changeset
112 TODO
d4366a861859 Initial revision
darius
parents:
diff changeset
113
d4366a861859 Initial revision
darius
parents:
diff changeset
114 * X Interface (there already are several based on older versions of
d4366a861859 Initial revision
darius
parents:
diff changeset
115 MikMod, however none of them reached a very sophisticated level)
d4366a861859 Initial revision
darius
parents:
diff changeset
116 * File selector under ncurses
d4366a861859 Initial revision
darius
parents:
diff changeset
117 * View messages in .MTMs
d4366a861859 Initial revision
darius
parents:
diff changeset
118 * Write a /dev/sequencer driver so people with GUSes and AWE32s can
d4366a861859 Initial revision
darius
parents:
diff changeset
119 use hardware mixing
d4366a861859 Initial revision
darius
parents:
diff changeset
120
d4366a861859 Initial revision
darius
parents:
diff changeset
121
d4366a861859 Initial revision
darius
parents:
diff changeset
122 MIKMOD ON NON-LINUX PLATFORMS
d4366a861859 Initial revision
darius
parents:
diff changeset
123
d4366a861859 Initial revision
darius
parents:
diff changeset
124 First, check playercode/unix_drv/ to see if a driver has been written
d4366a861859 Initial revision
darius
parents:
diff changeset
125 for your platform. If so, you're in some luck. Theoretically you
d4366a861859 Initial revision
darius
parents:
diff changeset
126 then can simply edit the makefile to compile in your driver. It's
d4366a861859 Initial revision
darius
parents:
diff changeset
127 probably not that simple, however, as these drivers haven't been tested
d4366a861859 Initial revision
darius
parents:
diff changeset
128 with MikMod 3.0 and are carryovers from 2.15... I don't have access
d4366a861859 Initial revision
darius
parents:
diff changeset
129 to Suns, SGIs, etc with which to test. If you DO get MikMod working
d4366a861859 Initial revision
darius
parents:
diff changeset
130 with this distribution on another unix than Linux, or need some help
d4366a861859 Initial revision
darius
parents:
diff changeset
131 in doing so, E-Mail me! I want to support as many unices as possible
d4366a861859 Initial revision
darius
parents:
diff changeset
132 in the MikMod for Unix distribution.
d4366a861859 Initial revision
darius
parents:
diff changeset
133 BTW: FreeBSD uses the same sound driver as Linux, so the oss driver
d4366a861859 Initial revision
darius
parents:
diff changeset
134 should probably work fine. Werd to the FreeBSDers!
d4366a861859 Initial revision
darius
parents:
diff changeset
135 Also... This code was originally for DOS. DOSisms like the DOS
d4366a861859 Initial revision
darius
parents:
diff changeset
136 drivers and makefiles for Watcom C have been mostly deleted to save
d4366a861859 Initial revision
darius
parents:
diff changeset
137 space. Go to Jake Stine's web site for the DOS version.
d4366a861859 Initial revision
darius
parents:
diff changeset
138
d4366a861859 Initial revision
darius
parents:
diff changeset
139
d4366a861859 Initial revision
darius
parents:
diff changeset
140 CONTACT
d4366a861859 Initial revision
darius
parents:
diff changeset
141
d4366a861859 Initial revision
darius
parents:
diff changeset
142 You probably want to e-mail me at amstpi@freenet.tlh.fl.us as
d4366a861859 Initial revision
darius
parents:
diff changeset
143 this is an unsupported release of MikMod (that is, not supported by the
d4366a861859 Initial revision
darius
parents:
diff changeset
144 guy who officially owns MikMod now, Jake Stine)
d4366a861859 Initial revision
darius
parents:
diff changeset
145
d4366a861859 Initial revision
darius
parents:
diff changeset
146 offical Mikmod for Linux homepage is at
d4366a861859 Initial revision
darius
parents:
diff changeset
147 http://www.freenet.tlh.fl.us/~amstpi/mikmod.html
d4366a861859 Initial revision
darius
parents:
diff changeset
148
d4366a861859 Initial revision
darius
parents:
diff changeset
149 latest releases of Linux mikmod can also be found at
d4366a861859 Initial revision
darius
parents:
diff changeset
150 ftp://sunsite.unc.edu/pub/Linux/apps/sound/players
d4366a861859 Initial revision
darius
parents:
diff changeset
151
d4366a861859 Initial revision
darius
parents:
diff changeset
152 The offical offical MikMod homepage is Jake Stine's
d4366a861859 Initial revision
darius
parents:
diff changeset
153 (this is for the DOS version that MikMod for Unix is based upon)
d4366a861859 Initial revision
darius
parents:
diff changeset
154 http://www.epix.net/~dracoirs/mikmod
d4366a861859 Initial revision
darius
parents:
diff changeset
155
d4366a861859 Initial revision
darius
parents:
diff changeset
156 Other relevant web pages/email addresses can be found in various
d4366a861859 Initial revision
darius
parents:
diff changeset
157 parts of the source tree and documentation...
d4366a861859 Initial revision
darius
parents:
diff changeset
158
d4366a861859 Initial revision
darius
parents:
diff changeset
159 Hope this brings you hours of mod-listening pleasure!
d4366a861859 Initial revision
darius
parents:
diff changeset
160
d4366a861859 Initial revision
darius
parents:
diff changeset
161 - Peter Amstutz
d4366a861859 Initial revision
darius
parents:
diff changeset
162 11:30pm 16 October 1997