Documentation

Current Version: 0.99.3b (Public) – V0.99.5b (Dev/Discord)

What’s New?

  • V0.99.5b (Discord Release)
    • Fixed the “spaces in PeP path” issue with pulling APK files during initial set up.
    • Added update check on startup. Any special alerts will also show up in the Output log. For those concerned about privacy, two calls to my web site are made to get version and alert text. NO DATA IS SENT. There is an opt out check box at the top right of the window.
    • Moved GET HELP to a more appropriate location in the upper right.
  • V0.99.4b (Discord Release)
    • Apparently OST song playlists can safely be manipulated; so I removed the restrictions from those playlists to allow you to move things around. Users will test.
  • V0.99.3b (Public Release)
    • Beat Saber switching is all built in. Make sure your Beat Saber is already modded and run the new Playlist Editor Pro and you’ll be prompted to download the modded and unmodded APK files; there is no more manual process for preparing PeP to switch versions
    • First Run Wizard has a Quest 2 query.
    • During startup, PeP does various checks to see if you can/want to get apks downloaded from your Quest.
    • Added a closing warning if you didn’t set your IP address (you have to sit through the First Run Wizard if you don’t)
    • Tightened up Quest 2 calls for keep alive
    • Updated my config file calls to handle adding/updating keys more efficiently.
  • V0.99.2b (Discord Beta)
    • Added Beat Saber version switching (requires a lot of manual setup for now – see here)
    • Added Quest 2 checkbox to denote you’re using a Quest 2 so I can make some additional calls to the unit when working with it
    • Quest 2 likes to go to sleep and make BMBF stop responding to calls. I’ve added manual calls to the Quest 2 to wake it up – but BMBF must always be the last thing you ran and be front and center on the Quest 2 screen before you start working with PeP. Sucks, but it is what it is. These calls have to be added before any “comms” with Quest 2 – and I think I have them all in the latest beta, but I’m sure I missed one somewhere.
    • Hid the DL button for Backups (it was something I was working on and doesn’t work)
  • V0.99.1b (Public Release)
    • Forgot to update the FIRST RUN WIZARD with the datagrids. I used this opportunity to number the steps and rewrite some of the text for clarity.
    • Resized the TEST BMBF Server button to match the rest, since it is now inside a panel.
  • V0.99b (Discord Beta)
    • Another UI shuffle. I swear, this is the last one. This still fits in 1280×1024 resolution and it gives priority to the song lists themselves and opens up the columns added with the datagrids.
    • The sorting wasn’t working on the UNSORTED SONGS – took care of that.
    • Currently the datagrids are a facade for the real listviews hiding underneath (I really don’t want to recode everything just yet) so the sorting headers were turned off (since they wouldn’t have updated the datagrids). I have manually wired them up to simulate the button pushes. I know, they still don’t reverse sort … when I purge the listviews, we’ll get that back
    • Added the Beat Saber version number; it is fetched when you LOAD ALL and is displayed properly now. No more guessing what version of Beat Saber you have.
    • Big change; moved to asynchronous web client calls. I still have to lock out the UI, since I can’t have the user changing content while the config commit is happening (I suppose I could – just lock out the Save button – but this is safer). This is currently for CONFIG committal, but am going to move song uploading to Async too.
  • V0.98.3b (Discord Beta)
    • Cover uploading has been restored; the adb solution simply will not work – therefore, each cover change requires a CONFIG commit. Kinda sucks, but … it works again, anyway. 
  • V0.98.2b (Discord Beta)
    • Added the logic to stop FAVORITES from attempting to be parsed if user doesn’t have a usable SideQuest/ADB setup.
    • Added some graceful handling of timeouts during Config Processing. 
  • V0.98b (Discord Beta)
    • Finally, multi-select in the Song List views.
    • By request, you can now upload MULTIPLE songs manually instead of just one.  Again, no parsing or validation is done; if they are valid, they are added.  If not?  YMMV.  Each song is committed instead of the committing happening at the end – this takes longer, but it is safer in case of a downstream ZIP being bad. Also added a counter during upload.
    • Added sorting indicators for both panes to show what the current sorting selection is.  Note: when you move files to a pane, that pane’s sorting is reset.  I thought about making it sticky and forcing the pane to resort again after the copy – but it didn’t always make sense.  If you have an opinion, please let me know.
    • Expanded the backup tool to allow you to name your backups, delete your backups.  If you leave the backup name blank, it defaults to using a data/time stamp.  Also, since the date may no longer be part of the name, when you select a backup, it will show you the date/time it was created.
    • Fixed a window sizing issue that might have caused issues on 4k monitors.
    • Changed the PLAYLIST COVER uploader to use ADB vice CONFIG file hack (this was causing loss of data). We’re back to PNG only for now; I’ll have to write a converter for the other supported types.
    • Cover Search. Select a song, then click FIND by the cover. A premade Google search will pop up, searching for a cover for that artist, song title with some preconfigured settings to make sure you get a large, SQUARE image only. Nice?
    • Favorite Song Support: Put songs you want to try out in the BOOKMARKS folder. After you play, if you like the song, use Beat Saber’s FAVORITES button. When you bring that list up in PeP? A button will appear FAVORITES>>, click that and all Favorite songs are moved to the staging area for proper sorting into a permanent playlist.
  • V0.97b (Discord Beta)
    • NEW: Overhauled the UI; this is based on feedback and growth of the system.  Things are a bit more logically organized.
    • NEW: Native ADB commands based around SideQuest.  This is branded “BMBF Tools (BETA).  Start Wireless ADB, start/kill Beat Saber/BMBF – added beta installer to grab the LATEST BMBF and install it
    • Added button to search selected song on ScoreSaber
    • Laid some groundwork for being able to NAME your backups instead of using dates
    • Added sorting to lists for Artist, Mapper (ascending only, for now)
    • Added Song Author to the Selected Song window and did a little reformatting
  • V0.96b (Public Release)
    • FIX: Program Icon
    • FIX: Unsorted Song cover wouldn’t load (only the metadata).
    • UPDATED: Added JPG and GIF to the filetypes allowed for a cover upload
    • BETA: The ability to de-bookmark a song on your playlist!  Log into BSaber.com in your main browser.  Then you can use Playlist Editor Pro to select a song and “de-mark” it from your bookmarks.  
    • BETA: Added the ability to “preview” a song using Rabbit’s web player..
    • BSaber button added to open the song on BSaber.com
  • V0.95b (public release)
    • Added warning if you leave songs in the staging UNSORTED SONGS list; both pushing the Config or exiting the app.
    • Added a GET HELP button that brings you to these docs
    • BETA: Playlist Set Cover!  I’m using a sort of weird technique and I haven’t done a ton of testing, but if you choose a Playlist, hit Set Cover – choose a good size square PNG file.  Note: Upon selecting the image, the config will IMMEDIATELY be pushed without notice.  I will clean this up over time, put in size checks, image constraints etc.  I just had to share now.
    • Added FIRST RUN WIZARD that teaches the first time user the basics of how to get started.  Once you enter an IP address and exit?  That first run wizard will go away.  If you want to see it, clear your Quest IP and exit – restart the application.
  • V0.94b (internal)
    • Added sorting to both lists (unfortunately, there is a glitch in BMBF that the sorting of songs doesn’t commit to Quest; working with the unicorns to fix that – but it is still useful for finding and moving songs, so I left it in)
  • V0.93b (public release)Validation on IP address
    • Store IP address if the BMBF test is successful
    • Added notices regarding the rename and delete of BOOKMARKS
  • V0.92b (internal)
    • Clear lists when re-reading the config
    • Fixed ambiguity when doing a delete of a playlist
  • V0.91b (internal)
    • added restraints against MOVE ALLs working with built in playlists.
  • V0.9b (internal)
    • MOVE ALL left and right implemented
  • V0.8b (public)
    • Covers for Playlists and Songs added
  • V0.7b (internal)
    • DELETE songs support

Pre-Requisites

  • Beat Saber 1.7.0 (or higher)
  • BMBF 1.7.0 (or higher)

Getting Started

  • Make sure your Quest is up and running
  • BMBF is running (you’ll need your IP address)
  • Recommended to have your Quest charging (it won’t go to sleep as often)
  • The PC running PEP is on the same network as the Quest
  • As always, keep an eye on the OUTPUT/LOGS area for messages

Using Playlist Editor Pro

  • Run Playlist Editor Pro.
  • Enter your IP address in the QUEST INFO section.
  • Hit Test BMBF Status – make sure your PC can see the Quest
  • Make a backup of your Config; hit BACKUP CONFIG FROM QUEST (the dropdown will show the backup is ok)
  • Hit READ CONFIG FROM QUEST and your current playlists will be pulled from your Quest.
  • Use the PLAYLISTS drop down and manipulate your custom songs between them using the lists on the right.
  • You can create new playlists and rename any custom playlists (some playlists cannot be manipulated – see the Output area)
  • Once you have done all your editing, hit PUT CONFIG TO QUEST
  • At that point, I’d take another backup.
  • To restore a backup, select the backup and hit RESTORE.
  • You can deploy a song zip file with QUICK DEPLOY SONG TO QUEST. (it won’t show up in your playlists until you READ CONFIG FROM QUEST next).

Notes

  • Do your manual song deployments before you pull the config down from Quest – these show up in CUSTOM SONGS
  • If you keep BMBF open in your PC’s web browser, you can watch what is going on and verify visually PEP is working
  • NOTE: NOTHING IS COMMITTED UNTIL YOU HIT “PUT CONFIG TO QUEST”
  • Keep backups frequently during testing
  • Multiple select on song lists is disabled currently
  • Mass move of songs is disabled currently
  • During operations to the Quest, the application will not be responsive.  This is currently expected.
  • Sorting isn’t being respected by BMBF when the playlists are pushed. Unicorns are looking into this.