Skip to content

Home

Jump to bottom
JBSAN3 edited this page Feb 15, 2023 · 35 revisions

BeatSaberPlus (BS+) | French version

Discord https://discord.gg/63ebPMC (Download, Support, Testing, Early releases and cool new mods coming soon)
Patreon https://www.patreon.com/BeatSaberPlus if you want to support this project development!

READ THE PATCH NOTES ! 🥖

Current version : 5.0.3
BeatSaber compatibility : 1.21 to 1.27

Important: Most modules are disabled by default. Enable them in BeatSaberPlus -> Settings.

  • If you enable the Chat module, it will open a page in your browser for configuration.
  • To use the Multiplayer+ module, go to BeatSaberPlus -> Multiplayer+ and set it up. Use the Multiplayer+ button on the left panel instead of the Online button.

1 - Features

  • Chat: (Documentation)
    • Display in game your twitch chat (BBTV, FFZ, 7TV, Twitch Emotes/Cheermotes, emojis support).
    • Emotes cache system to save bandwidth on game start!
    • See subscriptions, follow, raid, bits events, channel redeems (channel points).
    • Twitch: Polls, Predictions(bets), HypeTrains
    • Viewer count.
    • Hide/show messages started with "!"
    • Lot of customization options (Color, Size, Filter TTS messages, hide specific events...).
  • ChatEmoteRain: (Documentation)
    • See emotes used in chat raining in game!
    • Support GIF / APNG / PNG files.
    • Custom emote rain when someone subscribe to your Twitch channel.
    • Advanced configuration options.
  • ChatIntegration: (Documentation)
    • Make some differents actions with events
    • Events can use -> Chat events / Level status / VoiceAttackCommands(plugin install requied)
    • Conditions -> Chat Request / Event enabled ? / Playing map ? / Cooldown / OBS Status
    • Actions -> Camera2 / Chat / EmoteRain / Event / GamePlay / Misc(waiting events) / NoteTweaker(profile changing) / OBS interact / SongChartVisualizer / Twitch
    • Inputs with the physical keyboard are available to change commands or channel point informations
  • ChatRequest: (Documentation)
    • Chat request system that allow your viewers to make requests with https://beatsaver.com/ website.
    • Display information about all difficulties for a song including NPS/Offset.
    • Display song description, votes, upload date when you select a song.
    • Display scores on song when you over one.
    • User, Mapper, Song ban system
    • Safe mode that hide any sensitive informations (Song name, artist, uploader..)
    • History & blacklist tab that let you see your request history and manage your blacklist.
    • An intelligent "!link" command that show current played song or last one and provide a link to beatsaver.com if the map is public, the command also works outside of request and in multiplayer!
      There are lots of other useful commands you can find in the wiki
  • GameTweaker: (Documentation)
    • Can remove note debris even with the Liv capture.
    • Can remove cut particles, obstacles particles, floor burn particles, floor burn effects, saber clash particles, world particles.
    • Precise reaction time (AKA offset) selection
    • Add an override light intensity option that let you boost/dim lights from 0% to 2000% (also work in static lights).
    • Can remove BTS/LinkinPark assets in a play environment, FullCombo loss animation, Editor button on the main menu, Promotional content from the menu.
    • Can remove fake 360 like levels in standard ones.
    • Can re-order player options menu for better accessibility.
    • Can automatically clean all old logs entry from your game folder to keep it clean.
    • Can add keyboard bindings to pause/continue/restart/exit a song in FPFC mode.
  • MenuMusic: (Documentation)
    • Replace menu ambient sounds with music!
    • Play any songs from your custom levels or your own selection of music!
    • Player interface shows in the menu on left with Prev/Random/Play/Pause/Next buttons and with a volume selector.
    • Supports EGG/OGG files.
    • A play button to play the current song level.
  • Multiplayer+: (Documentation)
    • Basic features included like Quick Play, Server creation, Joining code and room finding with basic search
    • In the rooms, you can change room code, hide and show the code, play up to 20 people (40 with one patreon present)
    • With your multiplayer+ setup, you can manage the permission for Mods, Vips or users to be able to get the code in chat with ‘!room’ or no
    • Custom Songs with BeatSaver support
    • ScoreSaber and BeatLeader support
    • Can disable your score submission
    • Noodle/Chroma & 360/90 maps support
    • In game avatars & movement sync
    • An option inside the room to see/not see other player while playing included
  • NoteTeaker: (Documentation)
    • Profiles can be created and ChatIntegrations can switch it with your events
    • Changing any parts of notes like dots(with sliders or not), arrow, arcs, note or bomb scale
    • A preview of your changes is on the right panel
    • Hide/show dot on directional notes support
  • SongChartVisualizer: (Documentation)
    • Preview map difficulty with a nice and beautiful graph in game that illustrate NPS (Notes per second).
    • Support for 90 & 360 levels.
    • Lot of customization options (Colors, Legend, Dash lines...).
  • SongOverlay:
    • Send game information to some overlays that are compatible with BS+
      • Game version
      • Game status (menu, playing)
      • Map info before playing a map
      • Pause or resume events
      • Score events (JSON format)

2 - How to Install

Before install the BeatSaberPlus mod, you must have the cores and libs dependencies listed at the bottom of this part. You can install dependencies with ModAssistant

  1. Join my Discord server by this link and go to the bsplus-releases channel to download the latest version of BeatSaberPlus !

    Note : The file is a zip file and contain some files. It contain differents optionals modules but the modules depends BeatSaberPlus.dll file. Hot Fixes can be published in this channel. See the module usefulness and features on top

  2. Extract all files or most files you need in BeatSaber/Plugin folder

  3. Open Beat Saber and see the left panel that contain BeatSaberPlus mod. Click on them and you can see most of your modules disabled by default. Go to setting and enable your modules.

To setup the Twitch chat, go to [EN] Basic Setup

READ THE PATCH NOTES ! 🥖

Modules enabled by default

  • Chat
  • Chat Emote Rain
  • Chat Integration Actions
  • Chat Request
  • Multiplayer+
  • Song Overlay

Modules disabled by default

  • Chat Integration
  • Game Tweaker
  • Menu Music
  • Note Tweaker
  • Song Chart Visualizer

Dependencies
- SongCore https://github.com/Kylemc1413/SongCore
- BeatSaberMarkupLanguage https://github.com/monkeymanboy/BeatSaberMarkupLanguage
Licenses

BSML

MIT License

Copyright (c) 2019 David L

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

ChatCore

MIT License

Copyright (c) 2020 Brian Weber

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

EnhancedStreamChat

MIT License

Copyright (c) 2020 brian91292

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Mirror

MIT License

Copyright (c) 2015, Unity Technologies Copyright (c) 2019, vis2k, Paul and Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Websocket-Sharp

MIT License

Copyright (c) 2020 Brian Weber

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

3 - Modules

Chat

See all events in the Twitch Chat like channel points, bits and more !

English Français

Chat Emote Rain

Create an emote rain in your game and customize it

English Français

Chat Request

The Chat Request module enables viewers to request maps to the streamer in their Twitch chat. When a request is carried out, it is added to the request queue. The streamer only has to open the waiting queue and click on the song to download it and play the map.

English Français

Chat Integrations

This plugin contain most events and actions for streamers. Viewers can do some interacts with you in chat and doing actions ingame

English Français

Game Tweaker

This module allow you to customize your game experience, customize and remove some base game features

English Français

Multiplayer Plus

Player with your friends with this module ! It's under developpement but you can play now

English Français

Menu Music

This module enables you to replace ambient noise with music from your custom songs or CustomMenuSongs folder.

English Français

Note Tweaker

This module enables you to do changes about any parts of notes(arrow, dots, bombs,...)

English Français

Song Chart Visualizer

This module make a little graph for you to see the map difficulty in time when you playing songs

English Français

Song Overlay

English Français

For other questions, see the FAQ Here

Clone this wiki locally