youtube-maze/README.md

31 lines
1.2 KiB
Markdown
Raw Normal View History

2020-11-28 00:18:23 +00:00
# YouTube Maze
2017-04-02 00:54:46 +00:00
2020-11-29 21:57:48 +00:00
Some YouTube creators have made video-gamebooks during which viewers are invited to make choices that influence the course of the narration.
2020-11-28 22:52:13 +00:00
This is generally implemented by breaking up the video into short interlinked segments.
2020-11-29 21:57:48 +00:00
This tool automatically generates visual representations of the networks underlying such games.
2017-04-02 00:54:46 +00:00
2020-11-29 01:19:11 +00:00
[See it live →](https://youtube-maze.delab.re)
2017-04-02 00:54:46 +00:00
2020-11-28 22:14:43 +00:00
## How Does it Work?
2017-04-02 00:54:46 +00:00
2020-11-29 21:57:48 +00:00
The [exploration algorithm](lib/explore.mjs) automatically downloads metadata about each video from YouTube and then proceeds to a breadth-first search to generate a graph which is laid out using [Graphviz](http://www.graphviz.org).
Only the links in the end screens and in the in-video cards are considered for the exploration.
2017-04-02 00:54:46 +00:00
2020-11-28 22:14:43 +00:00
## Running Locally
2017-04-02 00:54:46 +00:00
2020-11-28 22:14:43 +00:00
You can also run the server locally, provided you have a working installation of Node.JS and Graphviz.
2017-04-02 00:54:46 +00:00
```
2020-11-28 00:18:23 +00:00
git clone https://forge.delab.re/matteo/youtube-maze.git
cd youtube-maze
2017-04-02 00:54:46 +00:00
npm install
2020-11-28 22:14:43 +00:00
npm start
2017-04-02 00:54:46 +00:00
```
2020-11-28 22:14:43 +00:00
If everything goes as planned, you should be able to access the server by opening `http://localhost:3000` in your browser.
2020-11-28 14:16:09 +00:00
## License
2017-04-02 00:54:46 +00:00
2020-11-28 14:16:09 +00:00
This software is made available under the MIT license.
[See the full license text →](LICENSE)