|
1 | | -# BeatSaberPlus |
| 1 | +# BeatSaberPlus (BS+) |
2 | 2 |
|
| 3 | +**Discord** https://discord.gg/63ebPMC (**Download, Support, Testing, Early releases** and cool new mods coming soon) |
| 4 | +**Patreon** [https://www.patreon.com/BeatSaberPlus](https://www.patreon.com/BeatSaberPlus) **if you want to support this project development!** |
| 5 | + |
| 6 | +**[READ THE PATCH NOTES ! 🥖](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Patchnotes)** |
| 7 | + |
| 8 | +Current version : 5.0.3 |
| 9 | +BeatSaber : 1.21 to 1.26 |
| 10 | + |
| 11 | +IMPORTANT Most of the modules are disabled by default, you can enable then in BeatSaberPlus -> Settings |
| 12 | +IMPORTANT When you enable Chat module, it will open a page in your browser for configuring it |
| 13 | +IMPORTANT When you enable Multiplayer+ module, you can setup them in BeatSaberPlus -> Multiplayer+. To use the Multiplayer+ mod, don't use the **Online** button but use the **Multiplayer+** button on the left panel ! |
| 14 | + |
| 15 | +## **Main features** |
| 16 | + |
| 17 | + - **Chat:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat)) |
| 18 | + - Display in game your Twitch & Youtube (Patreons only) chat (7TV & FFZ & BTTV support). |
| 19 | + - **Emotes cache system to save bandwidth on game start!** |
| 20 | + - See subscriptions, follow, raid, bits events, channel redeems (channel points). |
| 21 | + - Twitch: Polls, Predictions(bets), HypeTrains |
| 22 | + - Viewer count. |
| 23 | + - Hide messages started with "!" |
| 24 | + - Lot of customization options (Color, Size, Filter TTS messages, hide specific events...). |
| 25 | + - **ChatEmoteRain:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-emote-rain)) |
| 26 | + - See emotes used in chat raining in game! |
| 27 | + - Support **GIF / APNG / PNG / WEBP** files. |
| 28 | + - Custom emote rain when someone subscribe to your Twitch channel. |
| 29 | + - Advanced configuration options. |
| 30 | +- **ChatIntegrations:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-integrations)) |
| 31 | + - Make some different actions with events |
| 32 | + - Events can use -> **Chat events / Level status / VoiceAttackCommands(plugin install requied)** |
| 33 | + - Conditions -> **Chat Request / Event enabled ? / Playing map ? / Cooldown / OBS Status** |
| 34 | + - Actions -> **Camera2 / Chat / EmoteRain / Event / GamePlay / Misc(waiting events) / NoteTweaker(profile changing) / OBS interact / SongChartVisualizer / Twitch** |
| 35 | + - **ChatRequest:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-request)) |
| 36 | + - Chat request system that allow your viewers to make requests with [https://beatsaver.com/](https://beatsaver.com/) website. |
| 37 | + - Display information about all difficulties for a song including NPS/Offset. |
| 38 | + - Display song description, votes, upload date when you select a song. |
| 39 | + - Display scores on song when you over one. |
| 40 | + - User, Mapper, Song ban system |
| 41 | + - Safe mode that hide any sensitive informations (Song name, artist, uploader..) |
| 42 | + - History & blacklist tab that let you see your request history and manage your blacklist. |
| 43 | + - **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! |
| 44 | + There are lots of other useful commands you can find in [the wiki](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Chat-Request#4---chat-commands)** |
| 45 | + - **GameTweaker:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#game-tweaker)) |
| 46 | + - **Can remove note debris even with the Liv capture** |
| 47 | + - **Can remove note debris, cut particles, obstacles particles, floor burn particles, floor burn effects, saber clash particles, world particles.** |
| 48 | + - **Precise reaction time (AKA offset) selection** |
| 49 | + - **Add an override light intensity option that let you boost/dim lights from 0% to 2000% (also work in static lights).** |
| 50 | + - Can remove BTS/LinkinPark assets in a play environment, FullCombo loss animation, Editor button on the main menu, Promotional content from the menu. |
| 51 | + - Can re-order player options menu for better accessibility. |
| 52 | + - Can automatically clean all old logs entry from your game folder to keep it clean. |
| 53 | + - Can add keyboard bindings to pause/continue/restart/exit a song in FPFC mode. |
| 54 | + - **MenuMusic:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#menu-music)) |
| 55 | + - Replace menu ambient sounds with music! |
| 56 | + - Play any songs from your custom levels or your own selection of music! |
| 57 | + - Player interface shows in the menu on left with Prev/Random/Play/Pause/Next buttons and with a volume selector. |
| 58 | + - **A play button to play the current song level**. |
| 59 | + - **Multiplayer+:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#multiplayer-plus)) |
| 60 | + - Basic features included like Quick Play, Server creation, Joining code and room finding with basic search |
| 61 | + - In the rooms, you can change room code, hide and show the code, play up to 20 people (40 with one patreon present) |
| 62 | + - 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 |
| 63 | + - Custom Songs with BeatSaver support |
| 64 | + - ScoreSaber and BeatLeader support |
| 65 | + - Can disable your score submission |
| 66 | + - Noodle/Chroma & 360/90 maps support |
| 67 | + - In game avatars & movement sync |
| 68 | + - An option inside the room to see/not see other player while playing included |
| 69 | + - **NoteTeaker:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#note-tweaker)) |
| 70 | + - Profiles can be created and [ChatIntegrations](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-integrations) can switch it with your events |
| 71 | + - Changing any parts of notes like dots(with sliders or not), arrow, arcs, note or bomb scale |
| 72 | + - A preview of your changes is on the right panel |
| 73 | + - Hide/show dot on directional notes support |
| 74 | + - **SongChartVisualizer:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#song-chart-visualizer)) |
| 75 | + - Preview map difficulty with a nice and beautiful graph in game that illustrate NPS (Notes per second). |
| 76 | + - Support for 90 & 360 levels. |
| 77 | + - Lot of customization options (Colors, Legend, Dash lines...). |
| 78 | + |
| 79 | + |
| 80 | +## **Dependencies** |
| 81 | + |
| 82 | +- SongCore [https://github.com/Kylemc1413/SongCore](https://github.com/Kylemc1413/SongCore) |
| 83 | +- BeatSaberMarkupLanguage [https://github.com/monkeymanboy/BeatSaberMarkupLanguage](https://github.com/monkeymanboy/BeatSaberMarkupLanguage) |
| 84 | + |
| 85 | + |
| 86 | +### **[How to install](https://github.com/hardcpp/BeatSaberPlus/wiki#2---How-to-Install)** |
| 87 | + |
| 88 | +### **[See the FAQ](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-FAQ)** |
| 89 | + |
| 90 | +### **[READ THE PATCH NOTES ! 🥖](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Patchnotes)** |
| 91 | + |
| 92 | +## **Special Thanks**: |
| 93 | +- **Vred#0001** For art & documentation |
| 94 | +- **Brase#6969** For documentation |
| 95 | +- **Crafang#8040** For documentation & translation |
| 96 | +- **Lucy#9197** For documentation |
| 97 | +- **redegg89#9290** For Documentation syntax/grammar |
| 98 | + |
| 99 | +## **Discord & Download/Update** |
| 100 | +https://discord.gg/63ebPMC |
| 101 | + |
| 102 | +## **Credits / Copyright** |
| 103 | +* [EnhancedStreamChat-v3](https://github.com/brian91292/EnhancedStreamChat-v3) |
| 104 | +* [TournamentAssistant](https://github.com/MatrikMoon/TournamentAssistant) |
| 105 | +* [Beat-Saber-Utils](https://github.com/Kylemc1413/Beat-Saber-Utils) |
| 106 | +* [BeatSaverDownloader](https://github.com/Kylemc1413/BeatSaverDownloader) |
| 107 | +* [BeatSaberMarkupLanguage](https://github.com/monkeymanboy/BeatSaberMarkupLanguage) |
| 108 | +* [websocket-sharp](https://github.com/sta/websocket-sharp) |
| 109 | + |
| 110 | +## **Screenshots** |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | + |
| 115 | + |
| 116 | + |
0 commit comments