Skip to content

Latest commit

 

History

History
59 lines (51 loc) · 4.21 KB

README.md

File metadata and controls

59 lines (51 loc) · 4.21 KB
Raw

MultiplayerAvatars (Steam/PC-Only) Build

A Beat Saber mod that adds CustomAvatars support to multiplayer.

Features

  • Sends avatar data to other players who have the mod.
  • Spawns other player's avatars.
  • Scales other player's avatars.

Installation

  1. Ensure you have the required mods.
  2. Download the MultiplayerCore file listed under Assets 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.
  3. Extract the zip file to your Beat Saber game directory (the one Beat Saber.exe is in).
    • The MultiplayerAvatars.dll (and MultiplayerAvatars.pdb if it exists) should end up in your Plugins folder (NOT the one in Beat Saber_Data).
  4. Optional: Edit Beat Saber IPA.json (in your UserData folder) and change Debug -> ShowCallSource to true. This will enable BSIPA to get file and line numbers from the PDB file where errors occur, which is very useful when reading the log files. This may have a slight impact on performance.

Requirements

These can be downloaded from BeatMods or using Mod Assistant.

  • MultiplayerCore 1.0.0+
  • CustomAvatar x.x.x+
  • SiraUtil 3.1.0+

Reporting Issues

  • 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 folder Beat Saber.exe is in).
  • If you ask for help on Discord, at least include your _latest.log file in your help request.

Contributing

Anyone can feel free to contribute bug fixes or enhancements to MultiplayerAvatars. 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.

Building

Visual Studio 2022 with the BeatSaberModdingTools extension is the recommended development environment.

  1. Check out the repository
  2. Open MultiplayerAvatars.sln
  3. Right-click the MultiplayerAvatars project, go to Beat 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 MultiplayerAvatars.csproj.user file to set the location of your game install. An example is showing below.
  4. The project should now build.

Troubleshooting: -If you have any issues with Nuget('' is not a valid version) or VS asks you to 'upgrade' the csproj, you're likely missing some neccessary VS2019 features.

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>

Donate

You can support development of MultiplayerAvatars by donating at the following links: