Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rolopogo authored Feb 26, 2019
1 parent ffec25f commit dc94fd2
Showing 1 changed file with 21 additions and 6 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,26 @@
# MusicVideoPlayer
An IPA plugin for playing videos inside BeatSaber

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

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

Features:
Download videos to your CustomSongs folder
Play stored videos when playing a custom song
Browse and search video content
**Download Videos in game**
* Use the provided keyboard or the shortcut buttons to fill in your search query
* Adjustable video quality settings
* `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)
* This plugin uses the application youtube-dl to do the heavy lifting, and will keep it up to date every launch

**Re-positionable screen**
* Preset positions are available in the settings menu
* Use the laser and `grip` button to re-position and rotate the screen to a custom position
* Use `Up` and `Down` on the track-pad or joystick to move the screen towards or away from you
* Use `Left` and `Right` to grow or shrink the screen
* Screen glows and affects the background, just like the existing lights

0 comments on commit dc94fd2

Please sign in to comment.