|
1 | | -# YouCube |
2 | | - |
3 | | -[](https://github.com/Commandcracker/YouCube/blob/main/LICENSE.txt) |
4 | | -[](https://github.com/tomodachi94/awesome-computercraft) |
5 | | - |
6 | | -[](https://github.com/Commandcracker/YouCube/actions/workflows/spellcheck.yml) |
7 | | -[](https://github.com/Commandcracker/YouCube/actions/workflows/deploy-page.yml) |
8 | | - |
9 | | -YouCube streams media from services like YouTube to [ComputerCraft: Tweaked](https://github.com/cc-tweaked/CC-Tweaked). \ |
10 | | -**Project Status: Proof of concept** |
11 | | - |
12 | | -## Installation |
13 | | - |
14 | | -### Client |
15 | | - |
16 | | -[](https://tweaked.cc/) |
17 | | - |
18 | | -[](https://tweaked.cc/) |
19 | | - |
20 | | -[](https://wiki.vexatos.com/wiki:computronics) |
21 | | - |
22 | | -[](https://github.com/Commandcracker/YouCube/actions/workflows/illuaminate-lint.yml) |
23 | | - |
24 | | - |
25 | | - |
26 | | -<https://user-images.githubusercontent.com/49335821/207105983-f3887269-51d2-4ea2-b8f5-4c4af87ccad4.mp4> |
27 | | - |
28 | | -The client can be installed by running the following command: |
29 | | - |
30 | | -```shell |
31 | | -pastebin run swsmNAf7 |
32 | | -``` |
33 | | - |
34 | | -or |
35 | | - |
36 | | -```shell |
37 | | -wget run https://raw.githubusercontent.com/Commandcracker/YouCube/main/installer.lua |
38 | | -``` |
39 | | - |
40 | | -#### Starting the Client |
41 | | - |
42 | | -```text |
43 | | -youcube |
44 | | -``` |
45 | | - |
46 | | -#### Libraries |
47 | | - |
48 | | -All libraries that are used by the [client](https://github.com/Commandcracker/YouCube/blob/main/client/youcube.lua). |
49 | | - |
50 | | -| Library | |
51 | | -|-------------------------------------------------------------------------------------------------------| |
52 | | -| [argparse](https://github.com/Commandcracker/cc-argparse) | |
53 | | -| [numberformatter](https://github.com/Commandcracker/YouCube/blob/main/client/lib/numberformatter.lua) | |
54 | | -| [semver](https://github.com/kikito/semver.lua) | |
55 | | -| [youcubeapi](https://github.com/Commandcracker/YouCube/blob/main/client/lib/youcubeapi.lua) | |
56 | | -| [string_pack](https://gist.github.com/MCJack123/d5973e4d8b7e46991c5f99ac4b076aec) | |
57 | | - |
58 | | -#### UnicornPKG (Experimental) |
59 | | - |
60 | | -YouCube can be installed with [unicornpkg](https://unicornpkg.madefor.cc/). \ |
61 | | -Just run `hoof install youcube` to install it. |
62 | | - |
63 | | -#### LevelOS / lStore |
64 | | - |
65 | | -[](https://github.com/Commandcracker/YouCube/actions/workflows/lstore-put.yml) |
66 | | - |
67 | | -On [LevelOS](https://discord.com/invite/vBsjGqy99U) YouCube can be installed by running `lStore get YouCube <path>` or `lStore get bpBYV1aG <path>` or by Using the StoreUI. |
68 | | - |
69 | | - |
70 | | - |
71 | | -#### Settings |
72 | | - |
73 | | -Settings that can be set with the CC: Tweaked [settings module](https://tweaked.cc/module/settings.html#v:get) |
74 | | - |
75 | | -| name | default | Description | |
76 | | -|-----------------------|---------|-------------------------------------------------| |
77 | | -| `youcube.server` | | First server that should be used | |
78 | | -| `youcube.keys.skip` | 32 (d)|Key code to skip song | |
79 | | -| `youcube.keys.back` | 30 (a)|Key code to head to previous song | |
80 | | -| `youcube.max_back` | 32 |Maximum ammount of songs that can be gone back to| |
81 | | - |
82 | | -#### Events |
83 | | - |
84 | | -List of events that are [queued](https://tweaked.cc/module/os.html#v:queueEvent) by youcube |
85 | | - |
86 | | -| Name | Arguments | Description | |
87 | | -|--------------------------|-----------|-------------------------------------------------| |
88 | | -| `youcube:vid_eof` | `data` | Called, when Video playback has ended | |
89 | | -| `youcube:audio_eof` | `data` | Called, when Audio playback has ended | |
90 | | -| `youcube:fill_buffers` | | Internal event (called when buffers are filled) | |
91 | | -| `youcube:status` | `data` | Status of the serversided media download | |
92 | | -| `youcube:playback_ended` | | Called, when all playback has ended | |
93 | | -| `youcube:vid_playing` | `data` | Called, when Video playback has started | |
94 | | -| `youcube:audio_playing` | `data` | Called, when Audio playback has started | |
95 | | -| `youcube:playing` | | Called, when playback has started | |
96 | | - |
97 | | -### Server |
98 | | - |
99 | | -[](https://www.python.org/downloads/) |
100 | | -[](https://github.com/Commandcracker/YouCube/actions/workflows/pylint.yml) |
101 | | - |
102 | | - |
103 | | - |
104 | | -YouCube has a some public servers, which you can use if you don't want to host your own server. \ |
105 | | -The client has the public servers set by default, so you can just run the client, and you're good to go. \ |
106 | | -Moor Information about the servers can be seen on the [doc](https://commandcracker.github.io/YouCube/). |
107 | | - |
108 | | -#### Requirements |
109 | | - |
110 | | -- [yt-dlp/FFmpeg](https://github.com/yt-dlp/FFmpeg-Builds) / [FFmpeg 5.1+](https://ffmpeg.org/) |
111 | | -- [sanjuuni](https://github.com/MCJack123/sanjuuni) |
112 | | -- [Python 3.7+](https://www.python.org/downloads/) |
113 | | - - [aiohttp](https://pypi.org/project/aiohttp/) |
114 | | - - [yt-dlp](https://pypi.org/project/yt-dlp/) |
115 | | - |
116 | | -You can install the required packages with [pip](https://pip.pypa.io/en/stable/installation/) by running: |
117 | | - |
118 | | -```shell |
119 | | -pip install -r server/requirements.txt |
120 | | -``` |
121 | | - |
122 | | -#### Starting the Server |
123 | | - |
124 | | -```bash |
125 | | -python server/youcube.py |
126 | | -``` |
127 | | - |
128 | | -#### Environment variables |
129 | | - |
130 | | -Environment variables you can use to configure the server. |
131 | | - |
132 | | -| Variable | Default | Description | |
133 | | -|-------------------|------------|---------------------------------------------| |
134 | | -| `HOST` | `0.0.0.0` | The host where the web server runs on. | |
135 | | -| `PORT` | `5000` | The port where the web server should run on | |
136 | | -| `TRUSTED_PROXIES` | | Trusted proxies (separated by comma`,`) | |
137 | | -| `FFMPEG_PATH` | `ffmpeg` | Path to the FFmpeg executable | |
138 | | -| `SANJUUNI_PATH` | `sanjuuni` | Path to the Sanjuuni executable | |
139 | | -| `NO_COLOR` | `False` | Disable colored output | |
140 | | -| `LOGLEVEL` | `DEBUG` | Python Log level of the main logger | |
141 | | - |
142 | | -### Docker Compose |
143 | | - |
144 | | -```yml |
145 | | -version: "2.0" |
146 | | -services: |
147 | | - youcube: |
148 | | - image: ghcr.io/commandcracker/youcube:main |
149 | | - restart: always |
150 | | - hostname: youcube |
151 | | - ports: |
152 | | - - 5000:5000 |
153 | | -``` |
| 1 | +# Moved to https://github.com/CC-YouCube |
0 commit comments