{"id":17520440,"url":"https://github.com/xaf/testingtfv","last_synced_at":"2025-03-28T23:24:13.164Z","repository":{"id":145629738,"uuid":"95308242","full_name":"XaF/testingTFV","owner":"XaF","description":null,"archived":false,"fork":false,"pushed_at":"2018-04-29T16:49:17.000Z","size":998,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"testappveyor","last_synced_at":"2024-04-18T03:43:21.186Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/XaF.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-24T16:09:17.000Z","updated_at":"2024-04-18T03:43:21.186Z","dependencies_parsed_at":"2023-04-27T16:02:06.621Z","dependency_job_id":null,"html_url":"https://github.com/XaF/testingTFV","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XaF%2FtestingTFV","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XaF%2FtestingTFV/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XaF%2FtestingTFV/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XaF%2FtestingTFV/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XaF","download_url":"https://codeload.github.com/XaF/testingTFV/tar.gz/refs/heads/testappveyor","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246113639,"owners_count":20725501,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-20T11:04:55.518Z","updated_at":"2025-03-28T23:24:13.146Z","avatar_url":"https://github.com/XaF.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"TraktForVLC [![Travis Build Status](https://travis-ci.org/XaF/TraktForVLC.svg?branch=master)](https://travis-ci.org/XaF/TraktForVLC) [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/e1ie51bwhbki60ns/branch/master?svg=true)](https://ci.appveyor.com/project/XaF/traktforvlc/branch/master)\n===========\n\n## Table of Contents\n\n  * [Presentation](#presentation)\n  * [Information](#information)\n    * [Credits](#credits)\n    * [Licence](#licence)\n  * [Installation](#installation)\n    * [Compatibility](#compatibility)\n      * [Operating System](#operating-system)\n      * [Python version](#python-version)\n      * [VLC version](#vlc-version)\n    * [Getting sources](#getting-sources)\n  * [Configuration](#configuration)\n    * [Configuring VLC](#configuring-vlc)\n      * [With VLC Settings](#with-vlc-settings)\n      * [With command line](#with-command-line)\n      * [Automatic configuration on Windows (without guarantee)](#automatic-configuration-on-windows-without-guarantee)\n    * [Configuring TraktForVLC](#configuring-traktforvlc)\n  * [Automatic start](#automatic-start)\n    * [On Linux](#on-linux)\n      * [Using Gnome](#using-gnome)\n      * [Using \u003ccode\u003e.bash_profile\u003c/code\u003e](#using-bash-profile)\n    * [On Windows](#on-windows)\n      * [Using scheduled tasks](#using-scheduled-tasks)\n    * [On Mac OS X](#on-mac-os-x)\n      * [Using a \u003ccode\u003e.plist\u003c/code\u003e file](#using-a-plist-file)\n  * [Issues](#issues)\n\n## Presentation\n\nTraktForVLC allows scrobbling [VLC] content to [trakt.tv] [1].\nSince there is no way for VLC to directly know if you are watching\na TV show or a Movie, this script will attempt to figure it out\nusing the name of the video and its length. It is therefore possible\nthat the script can't find what you're watching if your files are\nnot named properly.\n\n\n## Information\n### Credits\n\nThe TraktForVLC script is originally based off of [TraktForBoxee] [2]\nand works very similarly to it.\n\nThis version of the script is forked from [Wifsimster's TraktForVLC] [3],\nitself based on the original [quietcore's TraktForVLC] [4].\n\n### Licence\n\nCopyright (C) 2012       Chris Maclellan \u003c\u003cchrismaclellan@gmail.com\u003e\u003e\n\nCopyright (C) 2013       Damien Battistella \u003c\u003cwifsimster@gmail.com\u003e\u003e\n\nCopyright (C) 2014-2015  Raphaël Beamonte \u003c\u003craphael.beamonte@gmail.com\u003e\u003e\n\nThis program is free software; you can redistribute it and/or\nmodify it under the terms of the GNU General Public License\nas published by the Free Software Foundation; either version 2\nof the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  [See the\nGNU General Public License for more details] [GPLv2].\n\n\n## Installation\n### Compatibility\n#### Operating System\nAs I'm a fervent [Linux] [5] user, this version of the script\nhas only been used and tested on Linux [Debian] [6]. I will\nnot be able to maintain directly the [Windows] [7] compatibility\nbut I'm open to pull requests on this side, as we're here to\nshare.\n\n#### Python version\nThis version of TraktForVLC has been tested using Python 2.7.9 and Python 3.4.2\nIt should however be compatible with the following versions:\n+ Python 2.6\n+ Python 2.7\n+ Python 3.3\n+ Python 3.4\n\n#### VLC version\nThis version of TraktForVLC has been tested using VLC 2.2.0 Weatherwax\n\n### Getting sources\nTo get the sources, you only need to clone the repository using\nthe following command on Linux:\n\n```sh\ngit clone https://github.com/XaF/TraktForVLC.git\n```\n\nOn [Windows] [7], you can download the [last version of the ZIP package] [8].\n\n## Configuration\n### Configuring VLC\n#### With VLC Settings\nGo to:\n+ **Tools**\n+ then **Preferences**\n\nIn the preferences window that just opened, look at the bottom\nleft and check **All**.\n\nThen, in the menu that appeared in place of the icons on the\nleft, go to:\n+ **Interface**\n+ **Main interfaces**\n\nHere, in the list of **Extra interface modules**, check **Remote control interface**.\n\n\u003e **WARNING** in some versions of VLC, when checking **Remote control interface**,\n\u003e you will see **oldrc** appearing in the lines below. If it is the case, please\n\u003e edit manually that line to read **rc** instead. TraktForVLC can use **oldrc**,\n\u003e but the behavior of **rc** is much more predictable thus preferable.\n\nThen, go to:\n+ **RC** (submenu of **Main interfaces**)\n\nAnd in the line **TCP command input** insert *localhost:4222* (you\ncan adjust the host and port if you want, but you'll have to keep\nit in mind for the next steps).\n\nOn [Windows] [7], you will also find a checkbox **Do not open a DOS\ncommand box interface** that you should check if you don't want\nto see a console each time you start VLC.\n\n#### With command line\nInstead of configuring [VLC], you can use parameters in your VLC\ncommand line to start the remote control server. The following line\ncan be use either way on [Linux] [5] or [Windows] [7] by adjusting\nthe `vlc` at start by the path to your [VLC] executable (usually\n`vlc.exe` on Windows).\n\n```sh\nvlc --extraintf=rc --rc-host=localhost:4222\n```\n\nOn [Windows] [7], you can also add the ```--rc-quiet``` option\nto disable the console.\n\n#### Automatic configuration on Windows (without guarantee)\n\nThe ```windows_batch/``` directory of this repository contains different\nbatch files. The file ```set_registry_keys.bat``` should allow to\nautomatically configure your system to open some multimedia files with\nVLC and with the right options.\n\nThe ```config.bat``` file allows to configure which multimedia files are\nconcerned, and other options needed before running the ```set_registry_keys.bat```:\n\n```batch\n:::: Configuration to set the registry keys\n:: Set the full path to the VLC exe file on your computer\nset vlc_path=C:\\your\\path\\to\\VideoLAN\\VLC\\vlc.exe\n\n:: Set the IP address VLC will listen to (default: localhost)\nset ip=localhost\n\n:: Set the port VLC will listen to (default: 4222)\nset port=4222\n\n:: Set the file formats for which you want VLC to be start\n:: listening to remote control for TraktForVLC to work. You\n:: can add as much format as you want, all format must be\n:: separated by a coma.\nset formats=avi, mkv, mov, mp4, wmv, ts, mpg\n```\n\nConfigure those options carefully, then run (double-click for instance) the\n```set_registry_keys.bat``` file. VLC should then be ready, you can now\n[configure TraktForVLC](#configuring-traktforvlc).\n\n### Configuring TraktForVLC\n\nTraktForVLC needs its `config.ini` file to work properly. The content\nof the file is as follow:\n\n```yaml\n[VLC]\nIP = localhost              # The host of the VLC Remote Control server\nPort = 4222                 # The port of the VLC Remote Control server\n```\n\nThis is the general server configuration. You should put here the same\ninformation you used in your configuration of VLC to allow TraktForVLC\nto connect to your VLC instance.\n\n```yaml\n[Trakt]\nPIN = [pin code]            # Identify yourself on the page https://trakt.tv/pin/2498\n\t\t\t                # and put here the resulting pin code\n```\n\nThis is a [trakt.tv pin you can get from this web page] [pin]. After\nthe first [trakt.tv] [1] connection, this ```PIN``` entry will be replaced\nautomatically by two new entries: ```access_token``` and ```refresh_token```.\nBe careful not to remove those entries from your configuration, or you will\nneed to put back a ```PIN``` entry with [a new freshly generated pin code from\ntrakt.tv] [pin].\n\n```yaml\n[TraktForVLC]\nTimer = 60                  # Time (sec) between each loop and look of TraktForVLC\nStartWatching = 30          # Time (sec) before considering a video is currently watched\nUseFilenames = No           # Whether or not to use filenames instead of VLC window title\nScrobblePercent = 90        # Percentage (%) of the video to be spent before scrobbling it\nScrobbleMovie = Yes         # Whether or not TraktForVLC will automatically scrobble movies\nScrobbleTV = Yes            # Whether or not TraktForVLC will automatically scrobble tv shows\nWatchingMovie = Yes         # Whether or not movies will be marked as being watched\nWatchingTV = Yes            # Whether or not tv shows will be marked as being watched\n```\nThis is the script-specific configuration, the time between each loop of\nwork, the time before considering you're effectively watching a video, and\nwhether or not scrobble automatically what you're watching on [trakt.tv] [1].\n\n## Automatic start\nThis script needs to be kept alive, and to be working when you start watching\nsomething. Achieving this need is very different if you're on [Linux] [5] or\n[Windows] [7]. This part aims to guide you to do these steps.\n\n### On Linux\nThere is different way to realize what we want to do on Linux. I'll just give\nhere two different and simple ways as reference.\n\n#### Using Gnome\nGo to your **Startup Applications Preferences**, then click on the **Add** button.\nHere, you can give the name you want to your task, and you only need to add the\nfollowing line in the **Command** box:\n```sh\npath/to/your/TraktForVLC.py --daemon\n```\n\nYour task will then automatically be started with your session.\n\n#### Using ```.bash_profile```\nIf you want to start Trakt automatically with your session but don't want to use\nGnome's **Startup Applications Preferences**, you can add the line proposed below\ndirectly in your `.bash_profile` script.\n\n### On Windows\n#### Using scheduled tasks\nA `start_process.bat` file is joined to the source files of TraktForVLC. You need to\nedit it to reflect the data and configuration directory of your TraktForVLC\ninstallation, then you can add this program as a scheduled task that starts when you\nopen your session.\n\n### On Mac OS X\n#### Using a ```.plist``` file\nSave the following file as ```org.TraktForVLC.plist``` in your ```~/Library/LaunchAgents/```\nfolder (you can copy and edit the file from the ```macosx``` directory of this repository):\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003c!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\"\n    \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\"\u003e\n\u003cplist version=\"1.0\"\u003e\n\u003cdict\u003e\n    \u003ckey\u003eLabel\u003c/key\u003e\n    \u003cstring\u003eorg.user.TraktForVLC\u003c/string\u003e\n    \u003ckey\u003eProgramArguments\u003c/key\u003e\n    \u003carray\u003e\n        \u003cstring\u003e[EDIT: /usr/bin/python]\u003c/string\u003e\n        \u003cstring\u003e[EDIT: /path/to/TraktForVLC/TraktForVLC.py]\u003c/string\u003e\n    \u003c/array\u003e\n    \u003ckey\u003eWorkingDirectory\u003c/key\u003e\n    \u003cstring\u003e[EDIT: /path/to/TraktForVLC]\u003c/string\u003e\n    \u003ckey\u003eRunAtLoad\u003c/key\u003e\n    \u003ctrue /\u003e\n    \u003ckey\u003eLaunchOnlyOnce\u003c/key\u003e\n    \u003ctrue /\u003e\n    \u003ckey\u003eKeepAlive\u003c/key\u003e\n    \u003ctrue /\u003e\n\u003c/dict\u003e\n\u003c/plist\u003e\n```\n\nAnd edit the ```[EDIT: ...]``` blocks to reflect your installation.\n\nYou can then load the file using the following command:\n```sh\nlaunchctl load ~/Library/LaunchAgents/org.TraktForVLC.plist\n```\n\n```TraktForVLC``` should be started as soon as you enter that last command,\nand will automatically be started for subsequent system boots.\n\n## Issues\nPlease use the [GitHub integrated issue tracker] [9] for every problem you can\nencounter. Please **DO NOT** use my email for issues or walkthrough.\n\nWhen submitting an issue, please submit a TraktForVLC logfile showing the error.\nYou can start TraktForVLC in debug mode (```--debug``` option) to obtain more\nthorough logs and with small timers (```--small-timers``` option) to speed up its\ninternal loop. The resulting logfile (```TraktForVLC-DEBUG.log```) should then be\navailable in your ```logs/``` directory.\n\n\u003e **Please** be careful to remove any personnal information that could still be in\n\u003e the logfile (password, identification token, ...) before putting your file online.\n\n\n\n[1]: https://trakt.tv/\n[2]: https://github.com/cold12/Trakt-for-Boxee\n[3]: https://github.com/Wifsimster/TraktForVLC\n[4]: https://github.com/quietcore/TraktForVLC\n[5]: https://www.kernel.org/\n[6]: https://www.debian.org/\n[7]: http://windows.microsoft.com\n[8]: https://github.com/XaF/TraktForVLC/archive/master.zip\n[9]: https://github.com/XaF/TraktForVLC/issues\n[VLC]: https://videolan.org/\n[GPLv2]: https://www.gnu.org/licenses/gpl-2.0.html\n[pin]: https://trakt.tv/pin/2498\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxaf%2Ftestingtfv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxaf%2Ftestingtfv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxaf%2Ftestingtfv/lists"}