KModBox Documentation
Index:
1 What is this?
2 Features
3 Installing the player
4 Configuring the player
5 Making some noise!
6 FAQ
7 The author
8 Development links
9 Copyright
This document is, and will
be, always under construction. Send me your comments and questions to the
address in the section 7 of this document.
1 What is this?
KModBox is a module player. It works under Linux + X-Windows + KDE,
and with, almost, every sound card that works under Linux.
It's still under alpha version, until I know from many of you that
it works properly in a wide variety of systems.
2 Features
The player is based on the MikMod library, then:
-
Module formats supported: M15, MOD, XM, IT, S3M, STM, MTM, 669, FAR, DSM,
MED, ULT, UNI.
-
Up to 44100 Hz mixing rate, with 16-bits stereo sound quality.
-
Dynamic digital filtering for improved sound quality.
-
A nice file browser :-)
-
Spanish ,English, versions. German and Hungarian versions thanks to Gyula
Kerekes.
-
It's FREE!
3 Installing the player
You'll need:
-
the Qt library version 1.42 (or superior) from Troll
Tech to run this program! If you don't have it, you can get it going
here. I recommend you to download the
Binary Usage RPM for Linux/i386 (aprox. 500Kb).
-
the K Desktop Environment 1.0 (or
superior).
- Notcice: Now you also need to download
the MikMod library
3.1.2 (or superior).
Then, just follow the next steps:
-
Copy the file "kmodbox.tgz" into a temporary directory (or where you
want!).
-
Uncompress the file with the command: "gunzip kmodbox.tgz"
-
Extract the files with: "tar xf kmodbox.tar"
-
Check that the directory "kmodbox" and was created (and
that some files exists inside it!).
Now, it's time to make it:
-
Download and install
the MikMod library.
-
Once mikmod is compiled and installed, go into the "kmodbox" directory.
-
Type: "./configure"
-
Then: "make"
-
And finally: "make install"
-
That's all!.
Now you'll see the program's icon in your "Multimedia" menu in KDE.
4 Configuring the player
In order to configure your player, you must click over the "Setup" button
in the program. Here is a brief description of the configuration items:
-
Stereo: when active, sets the stereo mode, if not, monophonic mode
is used.
-
Stereo separation: sets the stereo separation level for the
left/right channels.
-
Reverse Stereo: swaps the stereo channels.
-
Reverb: tells the player the level of reverberation.
-
Surround: when active, sets the surround sound mode.
-
16 bits: if checked, 16 bits mixing mode is enabled, if not, 8 bits
are used.
-
Filter: enable/disable dynamic filter.
-
Mixing rate: the mixing speed, you get more quality when its is
higher, but you'll need a fast machine for high speed rates.
-
Buffer size: sound buffer size, put it to the maximun value.
-
Initial directory: this is the first directory in where the program
try to find your MODs.
-
Repeat: tells the player if he must restart the mods if they have
loops. If disabled, the player will continue with the next module in the
directory.
Note: Since kmodbox 0.3.2 there's no need to restart the player for
make the changes take effect!!!.
5 Making some noise!
Well, you have the player installed, configured, and running, now it's
time to make some noise!
You can navigate through the directories using your mouse or the keyboard,
choose a module file, press "Enter" (or double click on it, or push the
"Play" button) and you must get it playing in a few milliseconds.
The rest is quite obvious, use the buttons in the bottom part of the
player to play, pause, stop, skip, etc.
You can change the volume using the slider that is on the right side.
6 FAQ
Q: Why is your english so bad?
A: 'cause I'm from Santa Fe, Argentina, and we speak in spanish here!.
So, if you find some really UGLY syntactic or semantic error in my home
page or in this document, please let me know about it!
Q: The sound gets cutted very often, can this be solved?
A: You can try this (it kinda works in Linux, I don't know about others
OS): edit the file modBox.cpp and uncomment the first line. Then recompile
kmodbox and tell me if it works for you! (you need to be the root user to
run kmodbox now).
Q: I have a lot of money and don't know what to do with it!
A: See the address below and contact me, maybe I can help you...
7 The author
Hey, that's me!
You can contact me:
-by the traditional way:
Guillermo P. Marotte
Av. Gorritti 4854
te: (42) 489-8030
CP 3000 - Santa Fe
Argentina
-by e-mail:
g-marotte@usa.net
8 Development links
This program was made using the widgets of the Qt library from Troll
Tech. You MUST take a look at this excellent library if you are planning
to make some programs under X-Windows / MS-Windows.
The sound comes from MikMod
Library, thanks to Miodrag Vallat.
Desktop Environment provided by KDE.
And, of course, I use Linux.
9 Copyright (copyleft!)
#include <std_disclaimer.h>
"I do not accept responsibility for any effects, adverse
or otherwise,
that this code may have on you, your computer, your
sanity, your dog,
and anything else that you can think of. Use it
at your own risk."
This program is free for any kind of uses. But if you are using it,
let me know!.
You can, better you MUST, freely, and ONLY freely, copy, and distribute
this programunder the GNU GPL License (see the file LICENSE).