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:

3 Installing the player

You'll need: Then, just follow the next steps:
  1. Copy the file "kmodbox.tgz" into a temporary directory (or where you want!).
  2. Uncompress the file with the command: "gunzip kmodbox.tgz"
  3. Extract the files with: "tar xf kmodbox.tar"
  4. Check that the directory "kmodbox" and was created (and that some files exists inside it!).
Now, it's time to make it: 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: 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.

Using playlists:

Since 0.4.0, KModBox supports playlist mode. To activate this mode, click on the "Playlist mode" button in the toolbar. Then you can add some files with the "+" button, or remove them with "-". You can also save and load playlists.
If you're in the "browser mode", you'll see playlists in the file list as yellows logos, double click over the item and the list will be loaded.
KModBox playlist files have the .modlist extension.

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
CP 3000 - Santa Fe
Argentina
te: (342) 489-8030

-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).