2017-11-03 01:03:14 +00:00
# Lidarr
2011-08-03 16:29:03 +00:00
2017-10-18 01:57:57 +00:00
[](https://ci.appveyor.com/project/lidarr/lidarr)
2017-10-18 12:10:20 +00:00
[](https://www.codacy.com/app/Lidarr/Lidarr?utm_source=github.com& utm_medium=referral& utm_content=lidarr/Lidarr& utm_campaign=Badge_Grade)
2018-04-01 17:33:28 +00:00
2018-04-07 05:06:22 +00:00
[](#backers) [](#sponsors)
2017-10-18 01:57:57 +00:00
2017-04-12 21:42:52 +00:00
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
2013-03-29 16:44:41 +00:00
2017-01-18 20:31:20 +00:00
## Major Features Include:
2013-03-29 16:44:41 +00:00
2017-01-18 20:31:20 +00:00
* Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc.
2017-03-31 04:12:51 +00:00
* Automatically detects new tracks.
* Can scan your existing library and download any missing tracks.
* Can watch for better quality of the tracks you already have and do an automatic upgrade.
2014-12-05 05:53:28 +00:00
* Automatic failed download handling will try another release if one fails
* Manual search so you can pick any release or to see why a release was not downloaded automatically
2017-11-03 01:03:14 +00:00
* Fully configurable track renaming
2017-01-18 20:31:20 +00:00
* Full integration with SABnzbd and NZBGet
* Full integration with Kodi, Plex (notification, library update, metadata)
2017-11-03 01:03:14 +00:00
* Full support for specials and multi-album releases
2014-12-05 05:53:28 +00:00
* And a beautiful UI
2013-03-29 16:44:41 +00:00
2017-03-31 03:34:40 +00:00
## Feature Requests
2017-08-26 14:31:55 +00:00
[](http://feathub.com/lidarr/Lidarr)
2017-03-31 03:34:40 +00:00
2017-11-03 01:03:14 +00:00
## Support
[](https://discord.gg/8Y7rDc9)
[](https://www.reddit.com/r/lidarr)
[](https://github.com/Lidarr/Lidarr/issues)
[](https://github.com/Lidarr/Lidarr/wiki)
2017-03-31 03:35:08 +00:00
## Configuring Development Environment:
2017-01-18 20:31:20 +00:00
### Requirements
2013-03-29 16:44:41 +00:00
2017-11-03 01:03:14 +00:00
* Visual Studio 2017 or higher (https://www.visualstudio.com/vs/). The community version is free and works (https://www.visualstudio.com/downloads/).
2017-01-18 20:31:20 +00:00
* [Git ](https://git-scm.com/downloads )
2017-11-03 01:03:14 +00:00
* [NodeJS ](https://nodejs.org/en/download/ ) (Node 6.X.X or higher)
* [Yarn ](https://yarnpkg.com/ )
2013-03-29 16:44:41 +00:00
2017-01-18 20:31:20 +00:00
### Setup
2013-03-29 16:44:41 +00:00
2017-01-18 20:31:20 +00:00
* Make sure all the required software mentioned above are installed.
* Clone the repository into your development machine. [*info* ](https://help.github.com/articles/working-with-repositories )
* Grab the submodules `git submodule init && git submodule update`
2017-11-03 01:03:14 +00:00
* Install the required Node Packages `yarn install`
* Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command.
* Build the project in Visual Studio
2017-05-06 14:44:46 +00:00
* Run the project in Visual Studio
* Open http://localhost:8686
2013-03-29 16:44:41 +00:00
2017-03-31 03:30:16 +00:00
*Please note gulp must be running at all times while you are working with Lidarr client source files.*
2013-03-29 16:44:41 +00:00
2017-01-18 20:31:20 +00:00
### Development
2013-03-29 16:44:41 +00:00
2017-09-21 23:12:08 +00:00
* Open `Lidarr.sln` in Visual Studio
2017-01-18 20:31:20 +00:00
* Make sure `NzbDrone.Console` is set as the startup project
2017-04-12 21:43:22 +00:00
* Change build to 'Debug x86'
2012-03-04 18:02:06 +00:00
2018-04-07 05:06:22 +00:00
## Contributors
This project exists thanks to all the people who contribute. [[Contribute ](CONTRIBUTING.md )].
< a href = "graphs/contributors" > < img src = "https://opencollective.com/lidarr/contributors.svg?width=890&button=false" / > < / a >
## Backers
Thank you to all our backers! 🙏 [[Become a backer ](https://opencollective.com/lidarr#backer )]
< a href = "https://opencollective.com/lidarr#backers" target = "_blank" > < img src = "https://opencollective.com/lidarr/backers.svg?width=890" > < / a >
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor ](https://opencollective.com/lidarr#sponsor )]
< a href = "https://opencollective.com/lidarr/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/lidarr/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/lidarr/sponsor/9/avatar.svg" > < / a >
2017-01-18 20:31:20 +00:00
### License
2012-03-04 18:02:06 +00:00
* [GNU GPL v3 ](http://www.gnu.org/licenses/gpl.html )
2017-01-18 20:31:20 +00:00
* Copyright 2010-2017
