Skip to content
This repository was archived by the owner on Jul 6, 2020. It is now read-only.

Commit 15b4c12

Browse files
committed
Prep README for 0.14.0 release
- Make some much needed updates to the README
1 parent 7bffd48 commit 15b4c12

File tree

1 file changed

+52
-49
lines changed

1 file changed

+52
-49
lines changed

README.md

Lines changed: 52 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -51,33 +51,20 @@ group.
5151

5252
<img src="screenshots/toby-video-search-by-group.png" alt="Video Selection - List By Group"/>
5353

54-
##Dependencies
55-
56-
If you want to run the latest code from master feel free. Toby requires
57-
Electron to run.
58-
59-
How to run master in Electron:
60-
61-
- Download Electron from https://github.com/atom/electron
62-
- Unzip Electron
63-
- Navigate to the resources folder
64-
- Create a folder called app
65-
- Clone the source code for Toby and dump it directly in the app folder
66-
- Open terminal to app folder
67-
- Run npm install to install node modules
68-
- Run bower install to install JavaScript dependencies
69-
- Run Electron
70-
- Enjoy life and have fun listening to awesome music (or anything) on YouTube!
71-
7254
##Current Release
7355

74-
https://github.com/frankhale/toby/releases/tag/v0.13.0
56+
https://github.com/frankhale/toby/releases/tag/v0.14.0
7557

7658
A Windows x64 binary has been provided in this release.
7759

78-
- Based on Electron 0.28.3, includes iojs 2.3.1 and a patched libchromiumcontent
79-
to override the HTTP referrer so that certain videos blocked from playback will
80-
play.
60+
- Based on Electron 0.29.2-master (after the 0.29.2 release), includes iojs 2.3.4
61+
and a patched libchromiumcontent to Chrome version 43.0.2357.132 as well as a
62+
patch to override the HTTP referrer so that videos blocked from playback by at least
63+
VEVO will play.
64+
65+
Developer Note: This custom HTTP referrer override patch is different than the
66+
httpreferrer override option in the webview tag. This one overrides the referrer
67+
for all web requests.
8168

8269
##Default Play List
8370

@@ -103,14 +90,30 @@ to add the video to your play list.
10390

10491
###How can I update the play list?
10592

93+
Currently you can update your playlist with new videos in three ways. The data for
94+
all your saved videos is in a file called data.json. I've included my favorite
95+
videos as an example in this release to get you started.
96+
97+
NOTE Location: toby-0.14.0\resources\app\assets\data\data.json
98+
99+
1. Update data.json manually (see below)
100+
2. Search Youtube by prefixing your search with "youtube:" or "yt:" and then
101+
using the F5 key to add a video you like to your playlist.
102+
2. After a video is played YouTube will show a listing of other videos you may
103+
like to watch. If you click on one and like it you can hit the F5 key to add
104+
it to your playlist. This will make it available when searching your videos
105+
the next time you want to watch it. Files added in this way will be added to
106+
a group called 'misc'. If you like you can edit your data.json and move them
107+
to a different group. A UI will be provided in the future to make this easier.
108+
109+
Updating data.json manually:
110+
106111
The data folder has a JSON file in it which is pretty self explanatory. There
107112
is an array of genres which have a set of videos that go with them. Basically
108-
what you do is you just grab the title of the video and the embed URL from
109-
YouTube and add it manually (for now) to the file. You can do this while the
113+
what you do is you just grab the title of the video and the video ID from the
114+
video URL on YouTube and add it manually to the file. You can do this while the
110115
app is running and the new entry will show up in your play list.
111116

112-
NOTE: See section Updating data.json for more information.
113-
114117
The data.json file has the following format:
115118

116119
There is just one big array of video groups, groups contain the title of the
@@ -133,35 +136,35 @@ that contain a description and a URL.
133136
}]
134137
```
135138

136-
###Recap Updating Play List
139+
###Some videos are blocked (VEVO), why?
137140

138-
Currently you can update data.json with new videos in two ways.
141+
From 0.13.0 forward I'm using the YouTube API so this requires a custom patch for
142+
libchromiumcontent so that the HTTP referrer is overridden for all web requests.
143+
Thus allowing blocked videos (from VEVO) to play (because the YouTube API requires an iframe
144+
and the httpreferrer override option only exists in webviews for a single HTTP source).
139145

140-
1. Update data.json manually (explained above)
141-
2. After a video is played YouTube will show a listing of other videos you may
142-
like to watch. If you click on one and like it you can hit the F5 key to add
143-
it to your data.json. This will make it available when searching your videos
144-
the next time you want to watch it. Files added in this way will be added to
145-
a group called 'misc'. If you like you can edit your data.json and move them
146-
to a different group.
146+
I will provide the necessary information for those developers inclined to patch
147+
their own libchromiumcontent until the time I can release a full fledged API to do
148+
this back to upstream Electron.
147149

148-
###Some videos are blocked, why?
150+
##Running Latest Code (not using the provided release binary)
149151

150-
From 0.13.0 forward I'm using the YouTube API so this requires a custom patch for
151-
libchromiumcontent so that the HTTP referrer is overridden for all web requests.
152-
Thus allowing blocked videos (from VEVO) to play.
152+
If you want to run the latest code from master feel free. Toby requires
153+
Electron to run.
153154

154-
Before 0.13.0 I was using a webview which provides a way to override the HTTP
155-
referrer and I was combining this with YouTube embed URLs so I didn't need to use
156-
the YouTube API. This worked well but I always wanted to use the YouTube API deep
157-
down. Since I've moved forward my intention is to provide a fully exposed API to
158-
do this in libchromiumcontent content and Electron. Until that day comes my intention
159-
is that users of Toby that desire playing videos from VEVO will use my provided
160-
binary release of Toby 0.13.0 or patch their own libchromiumcontent so that these
161-
videos play.
155+
How to run master in Electron:
162156

163-
I will provide the necessary information for those developers inclined to patch
164-
their own libchromiumcontent until I can release a full fledged API back upstream.
157+
- Download Electron from https://github.com/atom/electron
158+
- Unzip Electron
159+
- Navigate to the resources folder
160+
- Create a folder called app
161+
- Clone the source code using git or download a copy of this code from Github
162+
and dump it directly in the app folder
163+
- Open terminal to app folder
164+
- Run npm install to install node modules (requires iojs or node to be installed)
165+
- Run bower install to install JavaScript dependencies (requires bower to be installed)
166+
- Run Electron
167+
- Enjoy life and have fun listening to awesome music (or watching videos you love) on YouTube!
165168

166169
##Author(s)
167170

0 commit comments

Comments
 (0)