piercy / BeatFollowerPlugin

A BeatSaber plugin for keep track of your in game activities and recommending maps to other people.
https://www.beatfollower.com
11 stars 1 forks source link

BeatFollowerPlugin

A Beat Saber plugin to record activities and song recommendations to your BeatFollower.com profile. Twitch Extensions and other potential streamer tools are planned, along with external API's for tools to use.

Please raise issues for both the website and the plugin in the issues section.

To get started with BeatFollower you will need to install the BeatFollower Plugin to Beat Saber. Hopefully, in the future, the mod will be approved on BeatMods and appear in ModAssistant. However, for the moment you can grab it from the releases section of the GitHub Repository.

Prerequisites

Please make sure to have the following plugins installed:

Installation Instructions

  1. If you have installed the plugin with ModAssistant, you can skip to step 3. Start by downloading and extracting the latest BeatFollower.dll from the releases section of this GitHub repository
  2. Second, you should copy the BeatFollower.dll to your Beat Saber Plugins folder
  3. Next, you can start your game, but you should wait just a moment before putting your VR headset on..
  4. You now need to generate an API Key by visiting the Plugin Details tab, on your profile at BeatFollower.
    1. Make sure to click Generate Key. It's important not to share this key with anyone, if you do please go and generate a new one the follow the steps below.
  5. Copy your API Key and then open up the BeatFollower.ini in your prefered text editor. This file will be in the UserData folder, inside your Beat Saber installation folder (Note: you must start the game, with the plugin installed, for this file to get generated)
  6. Highlight the default API Key in the file (it should be a series of zero's). Then, paste the API Key you copied from this website. Make sure to save the file.
  7. That's it! You are good to go, you don't even need to restart the game.