Skip to content

Commit dc94fd2

Browse files
authored
Update README.md
1 parent ffec25f commit dc94fd2

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
11
# MusicVideoPlayer
22
An IPA plugin for playing videos inside BeatSaber
33

4-
Experimental phase - no support will be given on prereleases
4+
**Instructions:**
5+
Extract the contents of the release zip to your Beat Saber Directory, merge folders as necessary.
6+
Requires CustomUI, which can be obtained using the ModSaber Installer (https://github.com/lolPants/modsaber-installer/releases)
57

6-
Requires CustomUI
8+
# Features:
9+
**Play Videos in Beat Saber**
10+
* A custom json file `video.json` can be used in a song directory to detail a video
11+
* These are automatically created for downloaded files
12+
* Compatible with a wide range of video formats (check VideoPlayer Unity docs)
13+
* Supports manual sync, looping, thumbnails and metadata
714

8-
Features:
9-
Download videos to your CustomSongs folder
10-
Play stored videos when playing a custom song
11-
Browse and search video content
15+
**Download Videos in game**
16+
* Use the provided keyboard or the shortcut buttons to fill in your search query
17+
* Adjustable video quality settings
18+
* `video.json` can be shared and used to download the same video as another user (mappers can share `video.json` and players can automatically download the correct video and information)
19+
* This plugin uses the application youtube-dl to do the heavy lifting, and will keep it up to date every launch
20+
21+
**Re-positionable screen**
22+
* Preset positions are available in the settings menu
23+
* Use the laser and `grip` button to re-position and rotate the screen to a custom position
24+
* Use `Up` and `Down` on the track-pad or joystick to move the screen towards or away from you
25+
* Use `Left` and `Right` to grow or shrink the screen
26+
* Screen glows and affects the background, just like the existing lights

0 commit comments

Comments
 (0)