2016-05-30 08:26:08 +00:00
# musikcube
2016-05-30 08:29:26 +00:00
a cross-platform audio engine written in C++.
2016-05-30 08:26:08 +00:00
# musikbox
an ncurses frontend to musikcube.
2016-05-30 08:26:43 +00:00
2016-06-10 05:54:39 +00:00
musicbox compiles and runs easily on Windows, OSX and Linux.
2016-05-30 08:32:37 +00:00
2016-05-31 04:33:58 +00:00
it looks something like this on windows:
and this on osx:
2016-05-31 01:36:41 +00:00
# compiling
## windows
2016-05-31 05:17:46 +00:00
- grab the [Visual Studio 2015 Community Edition ](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx ) and install the C++ compiler and tools. the 32-bit compiler is currently used.
2016-05-31 01:36:41 +00:00
- clone the musikcube sources: `git clone https://github.com/clangen/musikcube.git`
2016-05-31 05:17:23 +00:00
- install the [32 bit version of boost 1.60 ](https://sourceforge.net/projects/boost/files/boost-binaries/1.60.0/boost_1_60_0-msvc-14.0-32.exe/download ). ensure it shares the same parent directory with musikcube. e.g: `c:\src\musikcube` and `c:\src\boost_1_60_0` -- the project's solution will reference it via relative path.
2016-05-31 04:38:10 +00:00
- open `musikcube.sln` and build/run.
2016-05-31 01:36:41 +00:00
## mac
2016-05-31 04:38:54 +00:00
you'll need [homebrew ](http://brew.sh/ ) to install the required dependencies.
2016-05-31 01:36:41 +00:00
2016-06-10 00:07:39 +00:00
- `brew install cmake boost libogg libvorbis flac mpg123 faad2 taglib`
2016-05-31 01:36:41 +00:00
- `git clone https://github.com/clangen/musikcube.git`
- `cd musikcube`
- `cmake .`
- `make`
- `cd bin`
2016-05-31 03:09:38 +00:00
- `./musikbox`
2016-05-31 01:36:41 +00:00
2016-06-10 05:54:39 +00:00
## linux
- install the following libraries and their development packages: `cmake boost libogg vorbis flac mpg123 faad2 taglib`
- `git clone https://github.com/clangen/musikcube.git`
- `cd musikcube`
- `cmake .`
- `make`
- `cd bin`
- `./musikbox`
2016-05-31 04:45:13 +00:00
## keyboard shortcuts
the current hotkeys are generally based around holding the alt/meta key with your left thumb, and using the home row with your right hand.
2016-06-24 05:22:26 +00:00
- `TAB` select next window
- `SHIFT+TAB` select previous window
2016-06-24 05:21:10 +00:00
- `ALT+~` switch to console view
- `ALT+a` switch to library view
2016-06-24 04:51:01 +00:00
- `ALT+s` switch to settings view
2016-05-31 04:45:13 +00:00
- `ALT+i` volume up 5%
- `ALT+k` volume down 5%
- `ALT+j` previous track
- `ALT+l` next track
- `ALT+u` back 10 seconds
- `ALT+o` forward 10 seconds
- `ALT+r` repaint the screen
2016-06-25 18:30:28 +00:00
- `ALT+,` toggle repeat mode (off/track/list)
2016-05-31 04:45:13 +00:00
- `CTRL+p` pause/resume (globally)
2016-06-25 18:40:24 +00:00
- `CTRL+x` stop (unload streams, free resources)
2016-05-31 04:45:13 +00:00
- `CTRL+d` quit
2016-06-04 05:29:01 +00:00
and a couple hotkeys that are specific to the library view:
- `ALT+n` or `ESC` switch between browse and play queue
2016-06-18 19:35:23 +00:00
- `ALT+b` show browse view
2016-06-18 19:34:26 +00:00
- `ALT+f` show category (album/artist/genre) search view
- `ALT+t` show track search view
2016-06-04 05:29:01 +00:00
- `ALT+1` browse by artist
- `ALT+2` browse by album
- `ALT+3` browse by genre
- `SPACE` pause/resume
2016-05-31 05:03:36 +00:00
*important*: on OSX make sure you configure your terminal emulator to treat your left alt key as "+Esc" or "Meta".
2016-05-30 08:32:37 +00:00
# sdk
2016-05-31 04:45:13 +00:00
musikcube is built around its own SDK interfaces. they're still in the process of being cleaned up and slimmed down. you can see what they look like here: https://github.com/clangen/musikcube/tree/master/src/core/sdk
