SickGear/readme.md

<hr>
<div><a id="top"><img alt="SickGear" width="200" src="https://raw.githubusercontent.com/wiki/SickGear/SickGear.Wiki/images/SickGearLogo.png"></a></div>
**SickGear**, a usenet and bittorrent PVR
<hr>
_Please note you should know how to use git and setup basic requirements in order to run this software._

SickGear provides management of TV shows and/or Anime, it can detect new episodes, link to downloader apps, and more.  SickGear is a proud descendant of Sick Beard and is humbled to have been endorsed by one of its former lead developers.  

Why SickGear?  
* SickGear maintains perfect uptime with the longest track record of being stable, reliable and trusted to work
* SickGear delivers quality from active development with a wealth of options on a dark or light themed interface
* [Migrating](https://github.com/SickGear/SickGear/wiki/Install-SickGear-%5B0%5D-Migrate) to a hassle free and feature rich set up is super simple

## Features include
* Stable, quality assured testing and development cycle
* Innovations that inspire imitators
* Compatible with any platform via a familiar web interface
* Most comprehensive selection of usenet and torrent sources
* Episode management
  * View missed and upcoming shows at a glance with "day by day" and other layouts
  * Group shows into personalised sections in a full show list view
  * Automatic and manual search for availability of wanted episodes
  * Set what episodes you want and how to receive them
  * Uses well known established index sites to gather show information
  * Searches for known alternatively named shows with a fallback to user edited names
  * Searches for known alternatively numbered episodes with a fallback to user edited numbers
  * Searches for known alternatively numbered seasons with a fallback to user edited numbers
  * Forward search results to a downloader (e.g. NZBGet, SABNZBd, uTorrent, and others)
  * Save search results to a "blackhole" folder that can be periodically scanned for taking action
  * Post-process downloaded episodes into customisable layouts, with or without extra metadata
  * Advanced Failed Download Handling (FDH)
  * Overview of seasons, episodes, rating, version, airdate, episode status ([their meaning](https://github.com/SickGear/SickGear/wiki/Status-Modes))
* Processing nzb/torrents with your downloader application at your chosen qualities
* Subtitle management
* Notification
  * Home Theater/NAS (Emby, Kodi, Plex, Syno, Tivo, and more)
  * Social notifiers (Trakt, Slack, Gitter, Discord, E-mail, and more)
  * Device notifiers (Boxcar2, Notify My Android, Growl, Prowl, and more)
* Server friendly with minimal number of calls (e.g. one request per chosen snatch, not per result)
* Can recommend trendy and/or personally tailored shows from Trakt, IMDb, AniDB
* Automated alternative show names and episode numbering from XEM

Some of our innovative features;
* Automated search after adding a show
* Desktop notifications
* Enhanced Anime features when adding shows
* Visual percentage progress of managed episodes
* Separate Plex server and Plex client settings
* Intelligent library updates that target Plex servers that list the show of an episode
* Configurable episode status for removed media files
* Configurable default home page
* Source providers
* User Interface

## Screenies
<table><thead></thead><tbody>
<tr align="center">
  <td><a title="Show List - Layout: Simple" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-simple.jpg"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-simple-t.jpg" width="200"></a></td>
  <td><a title="Show List - Layout: Banner" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-banner.jpg"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-banner-t.jpg" width="200"></a></td>
  <td><a title="Show List - Layout: Poster" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-poster.jpg"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-poster-t.jpg" width="200"></a></td>
  <td><a title="Episode View - Layout: Day by Day" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-day-by-day.jpg"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-day-by-day-t.jpg" width="200"></a></td>
  <td><a title="Episode View - Layout: List" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-list.jpg"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-list-t.jpg" width="200"></a></td>
  <td><a title="Display Show" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/displayshow.jpg"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/displayshow-t.jpg" width="200"></a></td>
  <td><a title="Add from Trakt" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/addshow-trakt.gif"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/addshow-trakt-t.jpg" width="200"></a></td>
  <td><a title="Edit Show" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/editshow.gif"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/editshow-t.jpg" width="200"></a></td>
</tr>
<tr align="center">
  <td>Show List: Simple<br />Theme: <a title="Theme Dark" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-simple.jpg">Dark</a>, <a title="Theme Light" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-simple-light.jpg">Light</a></td>
  <td>Show List: Banner<br />Theme: <a title="Theme Dark" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-banner.jpg">Dark</a>, <a title="Theme Light" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-banner-light.jpg">Light</a></td>
  <td>Show List: Poster<br />Theme: <a title="Theme Dark - Anime" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-poster.jpg">Dark</a>, <a title="Theme Dark 2" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/showlist-poster2.jpg">Dark 2</a></td>
  <td>Episode View: Day by Day<br />Theme: <a title="Theme Dark" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-day-by-day.jpg">Dark</a>, <a title="Theme Light" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-day-by-day-light.jpg">Light</a></td>
  <td>Episode View: List<br />Theme: <a title="Theme Dark" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-list.jpg">Dark</a>, <a title="Theme Dark - Anime" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-list2.jpg">Dark 2</a>, <a title="Theme Light" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/episodeview-list-light.jpg">Light</a></td>
  <td>Display Show<br />Theme: <a title="Theme Dark" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/displayshow.jpg">Dark</a>, <a title="Theme Light" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/displayshow-light.jpg">Light</a></td>
  <td>Add from Trakt<br />Theme: <a title="Theme Dark" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/addshow-trakt.gif">Dark</a></td>
  <td>Edit Show<br />Theme: <a title="Theme Dark" href="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/screenies/editshow.gif">Dark</a></td>
</tr>
</tbody>
</table>

## Available versions
<table><thead></thead><tbody>
<tr align="center">
  <td>Master (<a title="Master Changelog" href="/SickGear/SickGear/src/master/CHANGES.md">changes</a>)</td><td>(most stable)</td><td><a id="top" title=""><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/badge-stability.png"></a></td><td><a id="top" title="Build Status: Stable = Terrific!"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/badge-stable.png"></a></td>
</tr>
<tr align="center">
  <td>Development (<a title="Development Changelog" href="/SickGear/SickGear/src/develop/CHANGES.md">changes</a>)</td><td>(mostly stable)</td><td><a id="top" title="Where some imitate"><img src="https://raw.githubusercontent.com/wiki/SickGear/SickGear/images/badge-innovate.png"></a></td><td><a title="Build Status: Passing = All good!" target="_blank" href="https://travis-ci.org/SickGear/SickGear"><img src="https://travis-ci.org/SickGear/SickGear.svg?branch=develop"></a></td>
</tr>
<tr align="center">
<td colspan=5>[ ++ Install <a href="https://github.com/SickGear/SickGear/wiki/Installation-Instructions">Guides</a> ++ ][ Frequently <a href="https://github.com/SickGear/SickGear/wiki/Frequently-Answered-Questions">Answered</a> ][ Discover <a href="https://github.com/SickGear/SickGear/wiki">Wiki</a> ]</td>
</tr>
</tbody>
</table>

## Howto

#### Report issues
The following [guidelines](https://github.com/SickGear/SickGear/wiki/%5BHow-to%5D-Report-Issues) prevent reported issues getting messy and help us quickly get to the nub of an issue.  Please be aware that we require all requested information and that missing details will likely result in the reported issue being closed.

#### Contribute code
Please read this [guide](https://github.com/SickGear/SickGear/wiki/%5BHow-to%5D-Contribute-Code).  Directions  include coding with git and submitting pull requests.
If your pull request is a new feature, please try explaining its function to a limit of 200 characters.  Better, talk to our devs in IRC (details below).

## Contributors

#### To core
MidgetSpy, zoggy, 1337, Tolstyak, Mr_Orange, Bricky, JackDandy, Prinz23, Supremicus, adam111316, and zanaga  

#### In other areas, testers and QA
Warm thanks to tehspede, CtrlAltDefeat, Mike, vergessen (betrayed), and Rawh for their keen eye, all around help, and making sure all manner of things work as expected  

#### Provider code
Thanks also, to unsung heroes that added source providers; Idan Gutman, Daniel Heimans, jkaberg, and Seedboy  

Finally, a massive thanks to all those that remain in the shadows, the quiet ones who welcome folk to special places, we salute you for your hospitality and for tirelessly keeping up operations.  

## Community
* <a href="https://gitter.im/SickGear/"><img src="https://badges.gitter.im/sickgear.svg"></a> web based (most likely one on one with a dev)
* <a name="freenode"><img src="https://img.shields.io/badge/style-join%20chat-blue.svg?style=flat.svg&label=freenode"></a>&nbsp;(`irc.freenode.net` channel `#SickGear`)

Although support is available, you should understand the basics of your Linux or Windows OS.  If you don't understand basics like locating a db file, not running as root, or things like setting file permissions, then SickGear might not be for you.

---
Enjoy SickGear - stability, reliability, assured.