A Beat Saber mod that implements core custom multiplayer functionality.
NOT RELEASED FOR 1.19 YET
- Ensure you have the required mods.
- Download the
MultiplayerCore
file listed underAssets
Here.- Optionally, you can get a development build by downloading the file listed under
Artifacts
Here (pick the topmost successful build). - You must be logged into GitHub to download a development build.
- Optionally, you can get a development build by downloading the file listed under
- Extract the zip file to your Beat Saber game directory (the one
Beat Saber.exe
is in).- The
MultiplayerCore.dll
(andMultiplayerCore.pdb
if it exists) should end up in yourPlugins
folder (NOT the one inBeat Saber_Data
).
- The
- Optional: Edit
Beat Saber IPA.json
(in yourUserData
folder) and changeDebug
->ShowCallSource
totrue
. This will enable BSIPA to get file and line numbers from thePDB
file where errors occur, which is very useful when reading the log files. This may have a slight impact on performance.
Lastly, check out other mods that depend on MultiplayerCore!
These can be downloaded from BeatMods or using Mod Assistant.
- BSIPA v4.1.4+
- SongCore v3.2.0+
- BeatSaverSharp v3.0.1+
- SiraUtil 3.0.0+
- The best way to report issues is to click on the
Issues
tab at the top of the GitHub page. This allows any contributor to see the problem and attempt to fix it, and others with the same issue can contribute more information. Please try the troubleshooting steps before reporting the issues listed there. Please only report issues after using the latest build, your problem may have already been fixed. - Include in your issue:
- A detailed explanation of your problem (you can also attach videos/screenshots)
- Important: The log file from the game session the issue occurred (restarting the game creates a new log file).
- The log file can be found at
Beat Saber\Logs\_latest.log
(Beat Saber
being the folderBeat Saber.exe
is in).
- The log file can be found at
- If you ask for help on Discord, at least include your
_latest.log
file in your help request.
Anyone can feel free to contribute bug fixes or enhancements to MultiplayerCore. Please keep in mind that this mod's purpose is to implement core functionality of modded multiplayer, so we will likely not be accepting enhancements that fall out of that scope. GitHub Actions for Pull Requests made from GitHub accounts that don't have direct access to the repository will fail. This is normal because the Action requires a Secret
to download dependencies.
Visual Studio 2019 with the BeatSaberModdingTools extension is the recommended development environment.
- Check out the repository
- Open
MultiplayerCore.sln
- Right-click the
MultiplayerCore
project, go toBeat Saber Modding Tools
->Set Beat Saber Directory
- This assumes you have already set the directory for your Beat Saber game folder in
Extensions
->Beat Saber Modding Tools
->Settings...
- If you do not have the BeatSaberModdingTools extension, you will need to manually create a
MultiplayerCore.csproj.user
file to set the location of your game install. An example is showing below.
- This assumes you have already set the directory for your Beat Saber game folder in
- The project should now build.
Example csproj.user File:
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<BeatSaberDir>Full\Path\To\Beat Saber</BeatSaberDir>
</PropertyGroup>
</Project>
You can support development of MultiplayerCore by donating at the following links: