tomahawk/README.md

# This project is essentially abandoned
There is no one working on it.
There isn't much sense in adding any new issues in the issue tracker unless you want to fix them yourself.

# WHAT TOMAHAWK IS

Tomahawk is a free multi-source and cross-platform music player. An application that can play not only your local files, but also stream from services like Spotify, Beats, SoundCloud, Google Music, YouTube and many others. You can even connect with your friends' Tomahawks, share your musical gems or listen along with them. Let the music play!

![Tomahawk Screenshot](/data/screenshots/tomahawk-screenshot.png?raw=true)

## HOW TOMAHAWK WORKS

Tomahawk is basically a **player for music metadata**. At its core it decouples the metadata about a song from the source and reassembles it for each user based on their individual music accessibility and rights. In short, given the name of a song and artist, Tomahawk will find the right source, for the right user at the right time.  This fundamentally different approach to music enables a range of new music consumption and sharing experiences previously not possible.

## MUSIC SOURCES

* Local music library (MP3, Ogg, FLAC and many other formats)
* Networked music libraries (other connected computers)

### Subscription Music Services

* Spotify
* Beats Music
* Google Play Music (on-demand streaming and music locker)
* TIDAL
* Rdio (Android only)
* Deezer (Android only)

### Free Streaming/Music Promotion Platforms

* Soundcloud
* Bandcamp
* Last.fm
* Jamendo
* Official.fm
* YouTube

### Network/Cloud storage

* Ampache
* Owncloud
* Subsonic
* Beets

Third party-developed resolvers have also been written for services like YouTube, Qobuz and others. We've also heard of digital music distributors writing their own for their internal CMSes to help them navigate and preview their content. That's cool.

Packaged binary resolvers (.axes) are available: [here](http://teom.org/axes).

Source code (and examples) can be found in our [Resolver repository](https://github.com/tomahawk-player/tomahawk-resolvers).

## DOWNLOAD TOMAHAWK

You can download one of our nightly or stable builds:

| *BUILD* | MAC / OSX | WINDOWS | LINUX |
|:-------:|:---------:|:-------:|:-----:|
|**NIGHTLY** | [**latest**](http://download.tomahawk-player.org/nightly/mac/Tomahawk-latest.dmg) | [**latest**](http://download.tomahawk-player.org/nightly/windows/tomahawk-latest.exe) | [**latest**](https://launchpad.net/~tomahawk/+archive/ubuntu/nightly) (Ubuntu) |
|**STABLE** | [**0.8.4**](http://download.tomahawk-player.org/Tomahawk-0.8.4.dmg) | [**0.8.4**](http://download.tomahawk-player.org/tomahawk-0.8.4.exe) | [**0.8.4**](http://www.tomahawk-player.org/#page-about) (various distros) |

## BUILD TOMAHAWK

... or you can compile it yourself:

    $ mkdir build && cd build
    $ cmake ..
    $ make

### Detailed Build Instructions

| Linux: | [Arch](http://wiki.tomahawk-player.org/index.php/Building_ArchLinux_package) **-** [Debian](http://wiki.tomahawk-player.org/index.php/Building_on_Debian) **-** [Fedora](http://wiki.tomahawk-player.org/index.php/Building_on_Fedora) **-** [openSUSE](http://wiki.tomahawk-player.org/index.php/Building_on_openSUSE) **-** [Ubuntu](http://wiki.tomahawk-player.org/index.php/Building_on_Ubuntu) |
|------:|:------|
| **Windows**: | [**Windows**](http://wiki.tomahawk-player.org/index.php/Building_Windows_Binary) |
| **Mac**: | [**OS X**](http://wiki.tomahawk-player.org/index.php/Building_OS_X_Application_Bundle) |

### Dependencies

Required dependencies:

* [CMake 3](http://www.cmake.org/)
* [Qt >= 5.4.0](http://qt-project.org/)
* [VLC 2.1.0](https://videolan.org/vlc/)
* [SQLite 3.6.22](http://www.sqlite.org/)
* [TagLib 1.8](https://taglib.github.io/)
* [Boost 1.3](http://www.boost.org/)
* [Lucene++ 3.0.6](https://github.com/luceneplusplus/LucenePlusPlus/)
* [Attica 5.6.0](http://ftp.kde.org/stable/attica/)
* [QuaZip 0.4.3](http://quazip.sourceforge.net/)
* [liblastfm 1.0.9](https://github.com/lastfm/liblastfm/)
* [QtKeychain 0.1](https://github.com/frankosterfeld/qtkeychain/)
* [Sparsehash](https://code.google.com/p/sparsehash/)
* [GnuTLS](http://gnutls.org/)

If you are using Qt>5.6 you need to build and install QtWebKit

* [QtWebKit](https://github.com/qt/qtwebkit)

The following dependencies are optional (but *recommended*):

* [Jreen 1.1.1](http://qutim.org/jreen/)
* [Snorenotify 0.5.2](https://github.com/Snorenotify/Snorenotify/)

Third party libraries that we ship with our source:

* [MiniUPnP 1.6](http://miniupnp.free.fr/)
* [Qocoa](https://github.com/mikemcquaid/Qocoa/)
* [libqnetwm](https://code.google.com/p/libqnetwm/)
* [libqxt](http://libqxt.org/) (QxtWeb module)
* [SPMediaKeyTap](https://github.com/nevyn/SPMediaKeyTap/)
* [kdSingleApplicationGuard](http://www.kdab.com/)

## SUPPORT TOMAHAWK

* [Bug / Issue Tracker](https://bugs.tomahawk-player.org/secure/Dashboard.jspa)
* [Translations](https://www.transifex.com/projects/p/tomahawk/)
* [Donations](https://flattr.com/thing/169312/Tomahawk)

## GET HELP

* [Support & Feedback](https://tomahawk.uservoice.com)
* Chat with us in IRC: **#tomahawk** on Freenode, and [Scrollback.io](https://scrollback.io/tomahawk)
* [Twitter](https://twitter.com/tomahawk)
* [Facebook](https://facebook.com/tomahawkplayer)
* [Developer API Documentation](http://dev.tomahawk-player.org/api/classes.html)

## SCREENSHOTS

BROWSE FRIENDS' MUSIC & LISTEN ALONG

![Browse](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410998050088_listen-along.jpg)

INBOX - RECEIVED & FORWARDING

![Inbox](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410997751044_inbox.jpg)

CHARTS - BILLBOARD'S TASTEMAKER ALBUMS

![Charts](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410997901969_charts.jpg)

FRIEND FEED

![Feed](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410971283885_heroshot.png)

DYNAMIC (AUTO-UPDATING) PLAYLIST

![Xspf](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410998362549_dynamic-playlist-1.jpg)

PLUG-INS / RESOLVER SETTINGS

![Settings](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410998587408_prefs.jpg)

##Enjoy!
Update readme.md, someone has to say the obvious 2017-05-10 16:33:30 -07:00			`# This project is essentially abandoned`
Change 'noone' to 'no one' in README 2018-10-23 16:09:27 -04:00			`There is no one working on it.`
Update readme.md, someone has to say the obvious 2017-05-10 16:33:30 -07:00			`There isn't much sense in adding any new issues in the issue tracker unless you want to fix them yourself.`

Formatting changes 2015-01-09 00:17:25 +00:00			`# WHAT TOMAHAWK IS`
Convert README to markdown Github makes use of this fancy thing called markdown, so why don't use it? :) 2012-11-16 17:45:24 +01:00
Scrollback link + friends listen along clarification. 2015-01-08 23:56:05 +00:00			`Tomahawk is a free multi-source and cross-platform music player. An application that can play not only your local files, but also stream from services like Spotify, Beats, SoundCloud, Google Music, YouTube and many others. You can even connect with your friends' Tomahawks, share your musical gems or listen along with them. Let the music play!`
Added a description and screenshot. 2014-10-03 21:18:42 +02:00
			`![Tomahawk Screenshot](/data/screenshots/tomahawk-screenshot.png?raw=true)`

More clean ups. 2014-10-04 07:54:39 +02:00			`## HOW TOMAHAWK WORKS`
A bit more readable in a text editor. 2014-10-03 23:36:57 +02:00
Updated README. 2015-04-11 08:24:13 +02:00			`Tomahawk is basically a player for music metadata. At its core it decouples the metadata about a song from the source and reassembles it for each user based on their individual music accessibility and rights. In short, given the name of a song and artist, Tomahawk will find the right source, for the right user at the right time. This fundamentally different approach to music enables a range of new music consumption and sharing experiences previously not possible.`
Update readme 2014-10-03 17:15:53 -04:00
More clean ups. 2014-10-04 07:54:39 +02:00			`## MUSIC SOURCES`
A bit more readable in a text editor. 2014-10-03 23:36:57 +02:00
More cleanup. 2014-10-04 08:13:03 +02:00			`* Local music library (MP3, Ogg, FLAC and many other formats)`
Update readme 2014-10-03 17:15:53 -04:00			`* Networked music libraries (other connected computers)`

Wordy. 2014-10-04 07:55:29 +02:00			`### Subscription Music Services`
Update readme 2014-10-03 17:15:53 -04:00
			`* Spotify`
			`* Beats Music`
			`* Google Play Music (on-demand streaming and music locker)`
Added TIDAL and YouTube. 2015-04-28 00:15:14 +02:00			`* TIDAL`
Update readme 2014-10-03 17:15:53 -04:00			`* Rdio (Android only)`
			`* Deezer (Android only)`

More clean ups. 2014-10-04 07:54:39 +02:00			`### Free Streaming/Music Promotion Platforms`
Update readme 2014-10-03 17:15:53 -04:00
			`* Soundcloud`
			`* Bandcamp`
			`* Last.fm`
			`* Jamendo`
			`* Official.fm`
Added TIDAL and YouTube. 2015-04-28 00:15:14 +02:00			`* YouTube`
Update readme 2014-10-03 17:15:53 -04:00
More clean ups. 2014-10-04 07:54:39 +02:00			`### Network/Cloud storage`
A bit more readable in a text editor. 2014-10-03 23:36:57 +02:00
Update readme 2014-10-03 17:15:53 -04:00			`* Ampache`
			`* Owncloud`
			`* Subsonic`
			`* Beets`

			`Third party-developed resolvers have also been written for services like YouTube, Qobuz and others. We've also heard of digital music distributors writing their own for their internal CMSes to help them navigate and preview their content. That's cool.`

Typo-- 2014-10-03 23:41:10 +02:00			`Packaged binary resolvers (.axes) are available: [here](http://teom.org/axes).`
Markdown. Narf. 2014-10-03 23:40:15 +02:00
Consistency. 2014-10-03 23:42:08 +02:00			`Source code (and examples) can be found in our [Resolver repository](https://github.com/tomahawk-player/tomahawk-resolvers).`
Cleaned up and added various resources / links. 2014-10-03 21:27:25 +02:00
More clean ups. 2014-10-04 07:54:39 +02:00			`## DOWNLOAD TOMAHAWK`
Update readme 2014-10-03 17:15:53 -04:00
A bit more readable in a text editor. 2014-10-03 23:36:57 +02:00			`You can download one of our nightly or stable builds:`
Cleaned up and added various resources / links. 2014-10-03 21:27:25 +02:00
More cleanup. 2014-10-04 08:13:03 +02:00			`\| BUILD \| MAC / OSX \| WINDOWS \| LINUX \|`
			`\|:-------:\|:---------:\|:-------:\|:-----:\|`
Minor formatting changes 2015-01-09 00:17:11 +00:00			`\|NIGHTLY \| [latest](http://download.tomahawk-player.org/nightly/mac/Tomahawk-latest.dmg) \| [latest](http://download.tomahawk-player.org/nightly/windows/tomahawk-latest.exe) \| [latest](https://launchpad.net/~tomahawk/+archive/ubuntu/nightly) (Ubuntu) \|`
Updated README. 2015-04-15 08:55:34 +02:00			`\|STABLE \| [0.8.4](http://download.tomahawk-player.org/Tomahawk-0.8.4.dmg) \| [0.8.4](http://download.tomahawk-player.org/tomahawk-0.8.4.exe) \| [0.8.4](http://www.tomahawk-player.org/#page-about) (various distros) \|`
Update readme 2014-10-03 17:15:53 -04:00
More clean ups. 2014-10-04 07:54:39 +02:00			`## BUILD TOMAHAWK`
Update readme 2014-10-03 17:15:53 -04:00
			`... or you can compile it yourself:`
Convert README to markdown Github makes use of this fancy thing called markdown, so why don't use it? :) 2012-11-16 17:45:24 +01:00
			`$ mkdir build && cd build`
			`$ cmake ..`
			`$ make`

Update readme 2014-10-03 17:15:53 -04:00			`### Detailed Build Instructions`

3rd time lucky 2015-01-09 00:23:26 +00:00			`\| Linux: \| [Arch](http://wiki.tomahawk-player.org/index.php/Building_ArchLinux_package) - [Debian](http://wiki.tomahawk-player.org/index.php/Building_on_Debian) - [Fedora](http://wiki.tomahawk-player.org/index.php/Building_on_Fedora) - [openSUSE](http://wiki.tomahawk-player.org/index.php/Building_on_openSUSE) - [Ubuntu](http://wiki.tomahawk-player.org/index.php/Building_on_Ubuntu) \|`
			`\|------:\|:------\|`
Attempted table fix. 2015-01-09 00:21:51 +00:00			`\| Windows: \| [Windows](http://wiki.tomahawk-player.org/index.php/Building_Windows_Binary) \|`
Formatting changes 2015-01-09 00:17:25 +00:00			`\| Mac: \| [OS X](http://wiki.tomahawk-player.org/index.php/Building_OS_X_Application_Bundle) \|`
Update readme 2014-10-03 17:15:53 -04:00
			`### Dependencies`
Convert README to markdown Github makes use of this fancy thing called markdown, so why don't use it? :) 2012-11-16 17:45:24 +01:00
			`Required dependencies:`

Updated README. 2015-04-11 08:21:28 +02:00			`* [CMake 3](http://www.cmake.org/)`
Add QtWebKit as required dependency for Qt>5.6, fix cmake configuration errors on OSX 2019-12-08 16:03:58 +08:00			`* [Qt >= 5.4.0](http://qt-project.org/)`
Proper VLC url in README. 2014-10-22 11:37:40 +02:00			`* [VLC 2.1.0](https://videolan.org/vlc/)`
Update readme 2014-10-03 17:15:53 -04:00			`* [SQLite 3.6.22](http://www.sqlite.org/)`
Updated (broken) TagLib Link 2015-09-19 21:24:32 +02:00			`* [TagLib 1.8](https://taglib.github.io/)`
Update readme 2014-10-03 17:15:53 -04:00			`* [Boost 1.3](http://www.boost.org/)`
			`* [Lucene++ 3.0.6](https://github.com/luceneplusplus/LucenePlusPlus/)`
Updated README. 2015-04-11 08:21:28 +02:00			`* [Attica 5.6.0](http://ftp.kde.org/stable/attica/)`
Update readme 2014-10-03 17:15:53 -04:00			`* [QuaZip 0.4.3](http://quazip.sourceforge.net/)`
Updated README. 2015-04-11 08:21:28 +02:00			`* [liblastfm 1.0.9](https://github.com/lastfm/liblastfm/)`
Update readme 2014-10-03 17:15:53 -04:00			`* [QtKeychain 0.1](https://github.com/frankosterfeld/qtkeychain/)`
			`* [Sparsehash](https://code.google.com/p/sparsehash/)`
			`* [GnuTLS](http://gnutls.org/)`

Add QtWebKit as required dependency for Qt>5.6, fix cmake configuration errors on OSX 2019-12-08 16:03:58 +08:00			`If you are using Qt>5.6 you need to build and install QtWebKit`

			`* [QtWebKit](https://github.com/qt/qtwebkit)`

More clean ups. 2014-10-04 07:54:39 +02:00			`The following dependencies are optional (but recommended):`
Update readme 2014-10-03 17:15:53 -04:00
Updated README. 2015-04-11 08:21:28 +02:00			`* [Jreen 1.1.1](http://qutim.org/jreen/)`
			`* [Snorenotify 0.5.2](https://github.com/Snorenotify/Snorenotify/)`
Convert README to markdown Github makes use of this fancy thing called markdown, so why don't use it? :) 2012-11-16 17:45:24 +01:00
			`Third party libraries that we ship with our source:`

Update readme 2014-10-03 17:15:53 -04:00			`* [MiniUPnP 1.6](http://miniupnp.free.fr/)`
			`* [Qocoa](https://github.com/mikemcquaid/Qocoa/)`
Use https where possible. 2014-10-12 12:42:16 +02:00			`* [libqnetwm](https://code.google.com/p/libqnetwm/)`
Minor formatting changes 2015-01-09 00:17:11 +00:00			`* [libqxt](http://libqxt.org/) (QxtWeb module)`
Update readme 2014-10-03 17:15:53 -04:00			`* [SPMediaKeyTap](https://github.com/nevyn/SPMediaKeyTap/)`
			`* [kdSingleApplicationGuard](http://www.kdab.com/)`

More clean ups. 2014-10-04 07:54:39 +02:00			`## SUPPORT TOMAHAWK`

Minor formatting changes 2015-01-09 00:17:11 +00:00			`* [Bug / Issue Tracker](https://bugs.tomahawk-player.org/secure/Dashboard.jspa)`
Update readme 2014-10-03 17:15:53 -04:00			`* [Translations](https://www.transifex.com/projects/p/tomahawk/)`
Minor formatting changes 2015-01-09 00:17:11 +00:00			`* [Donations](https://flattr.com/thing/169312/Tomahawk)`
Update readme 2014-10-03 17:15:53 -04:00
More clean ups. 2014-10-04 07:54:39 +02:00			`## GET HELP`

Use https where possible. 2014-10-12 12:42:16 +02:00			`* [Support & Feedback](https://tomahawk.uservoice.com)`
Scrollback link + friends listen along clarification. 2015-01-08 23:56:05 +00:00			`* Chat with us in IRC: #tomahawk on Freenode, and [Scrollback.io](https://scrollback.io/tomahawk)`
Use https where possible. 2014-10-12 12:42:16 +02:00			`* [Twitter](https://twitter.com/tomahawk)`
			`* [Facebook](https://facebook.com/tomahawkplayer)`
Minor formatting changes 2015-01-09 00:17:11 +00:00			`* [Developer API Documentation](http://dev.tomahawk-player.org/api/classes.html)`
Update readme 2014-10-03 17:15:53 -04:00
More clean ups. 2014-10-04 07:54:39 +02:00			`## SCREENSHOTS`
Update readme 2014-10-03 17:15:53 -04:00
			`BROWSE FRIENDS' MUSIC & LISTEN ALONG`

			`![Browse](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410998050088_listen-along.jpg)`

			`INBOX - RECEIVED & FORWARDING`

			`![Inbox](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410997751044_inbox.jpg)`

			`CHARTS - BILLBOARD'S TASTEMAKER ALBUMS`

			`![Charts](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410997901969_charts.jpg)`

			`FRIEND FEED`

Fix broken readme image and be done with it already 2014-10-03 17:27:27 -04:00			`![Feed](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410971283885_heroshot.png)`
Update readme 2014-10-03 17:15:53 -04:00
			`DYNAMIC (AUTO-UPDATING) PLAYLIST`

			`![Xspf](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410998362549_dynamic-playlist-1.jpg)`

			`PLUG-INS / RESOLVER SETTINGS`

			`![Settings](https://dchtm6r471mui.cloudfront.net/hackpad.com_ZRZMJDdxrVe_p.242147_1410998587408_prefs.jpg)`

Formatting changes 2015-01-09 00:17:25 +00:00			`##Enjoy!`