mirror/musikcube
1
0
Fork 0
mirror of https://github.com/clangen/musikcube.git synced 2024-11-19 11:10:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
a cross-platform, terminal-based music player, audio engine, metadata indexer, and server in c++
444 Commits 30 Branches 114 Tags 76 MiB
C++ 79.3%
Kotlin 12.5%
C 4.8%
CMake 1.3%
Shell 1%
Other 0.9%
a89cdd9672
Go to file
clangen a89cdd9672 Update README.md
2016-05-30 22:17:23 -07:00
src Removed 3rdparty CMakeLists.txt. Just include this as part of libmusikcore. 2016-05-30 11:49:24 -07:00
static/screenshots Added a couple screenshots. 2016-05-30 21:31:19 -07:00
.gitignore Incremental checkin for compiling on mac. 3rdparty compiles, and core is nearly there (boost::async not working) 2016-05-27 17:47:29 -07:00
bootstrap.sh A couple small fixes that should allow things to (almost) compile in Linux. 2016-05-29 18:20:48 -07:00
CMakeLists.txt Removed 3rdparty CMakeLists.txt. Just include this as part of libmusikcore. 2016-05-30 11:49:24 -07:00
LICENSE.txt Updated installer and added LICENSE.txt 2008-05-17 18:14:10 +00:00
musikcube.sln Renamed "audioengine.sln" to "musikcube.sln" and removed the non-compiling projects. They will be added back as they are repaired. 2016-05-30 21:37:46 -07:00
README.md Update README.md 2016-05-30 22:17:23 -07:00

README.md

musikcube

a cross-platform audio engine written in C++.

musikbox

an ncurses frontend to musikcube.

musicbox compiles and runs easily on Windows and OSX (and Linux soon).

it looks something like this on windows:

windows screenshot

and this on osx:

osx screenshot

compiling

windows

  • install the Visual Studio 2015 Community Edition and install the C++ compiler and tools. the 32-bit compiler is currently used.
  • clone the musikcube sources: git clone https://github.com/clangen/musikcube.git
  • install the 32 bit version of boost 1.60. 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.
  • open musikcube.sln and build/run.

mac

you'll need homebrew to install the required dependencies.

  • brew install cmake boost libogg libvorbis flac mpg123 taglib
  • git clone https://github.com/clangen/musikcube.git
  • cd musikcube
  • cmake .
  • make
  • cd bin
  • ./musikbox

keyboard shortcuts

the user interface is very new and will change considerably over time.

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.

  • <TAB> tabs between windows
  • F1 switch to console view
  • F2 switch to library view
  • 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
  • <SPACE> pause/resume (only in library view)
  • CTRL+p pause/resume (globally)
  • CTRL+d quit

important: on OSX make sure you configure your terminal emulator to treat your left alt key as "+Esc" or "Meta".

sdk

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