Skip to content

Commit 5ff4edd

Browse files
committed
2 parents 902da07 + 08f074a commit 5ff4edd

File tree

1 file changed

+31
-18
lines changed

1 file changed

+31
-18
lines changed

README.md

Lines changed: 31 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,29 @@
33
**Discord** https://discord.gg/63ebPMC (**Download, Support, Testing, Early releases** and cool new mods coming soon)
44
**Patreon** [https://www.patreon.com/BeatSaberPlus](https://www.patreon.com/BeatSaberPlus) **if you want to support this project development!**
55

6-
Current version : 4.6.0
6+
Current version : 4.6.1
77

88
IMPORTANT Most of the modules are disabled by default, you can enable then in BeatSaberPlus -> Settings
99
IMPORTANT When you enable Chat module, it will open a page in your browser for configuring it
10-
IMPORTANT When you enable Multiplayer+ module, you can setup then in BeatSaberPlus -> Multiplayer+
10+
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 !
1111

12-
## Main features:
12+
## **Main features**
1313

1414
- **Chat:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat))
1515
- Display in game your Twitch & Youtube (Patreons only) chat (7TV & FFZ & BTTV support).
16+
- **Emotes cache system to save bandwidth on game start!**
1617
- See subscriptions, follow, raid, bits events, channel redeems (channel points).
1718
- Twitch: Polls, Predictions(bets), HypeTrains
1819
- Viewer count.
20+
- Hide messages started with "!"
1921
- Lot of customization options (Color, Size, Filter TTS messages, hide specific events...).
2022
- **ChatEmoteRain:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-emote-rain))
2123
- See emotes used in chat raining in game!
2224
- Support **GIF / APNG / PNG / WEBP** files.
2325
- Custom emote rain when someone subscribe to your Twitch channel.
2426
- Advanced configuration options.
25-
- **ChatIntegration:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Chat-Integrations)) <!-- Change this part later after making changes in the wiki -->
26-
- Make some differents actions with events
27+
- **ChatIntegrations:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-integrations))
28+
- Make some different actions with events
2729
- Events can use -> **Chat events / Level status / VoiceAttackCommands(plugin install requied)**
2830
- Conditions -> **Chat Request / Event enabled ? / Playing map ? / Cooldown / OBS Status**
2931
- Actions -> **Camera2 / Chat / EmoteRain / Event / GamePlay / Misc(waiting events) / NoteTweaker(profile changing) / OBS interact / SongChartVisualizer / Twitch**
@@ -35,38 +37,49 @@ IMPORTANT When you enable Multiplayer+ module, you can setup then in BeatSaberPl
3537
- User, Mapper, Song ban system
3638
- Safe mode that hide any sensitive informations (Song name, artist, uploader..)
3739
- History & blacklist tab that let you see your request history and manage your blacklist.
38-
**- 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!**
39-
- **GameTweaker:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#game-tweaker))
40+
- **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!
41+
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)**
42+
- **GameTweaker:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#game-tweaker))
43+
- **Can remove note debris even with the Liv capture**
4044
- **Can remove note debris, cut particles, obstacles particles, floor burn particles, floor burn effects, saber clash particles, world particles.**
4145
- **Precise reaction time (AKA offset) selection**
4246
- **Add an override light intensity option that let you boost/dim lights from 0% to 2000% (also work in static lights).**
43-
- Can remove BTS/LinkinPark assets in play environment, FullCombo loss animation, Editor button on the main menu, Promotional content from the menu.
47+
- Can remove BTS/LinkinPark assets in a play environment, FullCombo loss animation, Editor button on the main menu, Promotional content from the menu.
4448
- Can re-order player options menu for better accessibility.
49+
- Can automatically clean all old logs entry from your game folder to keep it clean.
50+
- Can add keyboard bindings to pause/continue/restart/exit a song in FPFC mode.
4551
- **MenuMusic:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#menu-music))
4652
- Replace menu ambient sounds with music!
47-
- Play any songs from your custom levels or you own selection of music!
53+
- Play any songs from your custom levels or your own selection of music!
4854
- Player interface shows in the menu on left with Prev/Random/Play/Pause/Next buttons and with a volume selector.
4955
- **A play button to play the current song level**.
50-
- **Multiplayer+:** (Documentation under construction!!)
51-
We are making a separate Multiplayer for Beat Saber. It can had some functionnalities for players and streamers. This part of BS+ is under developpment but players can now test and play it now. Stability and performance improvements have been seen for a better experience !
52-
- Functionnalities work for Quick Play, Server creation, Joining code and room finding with basic search
53-
- In the rooms, you can change room code, hide and show the code, play up to 20 peoples (30 with one patreon present)
54-
- With your multiplayer+ setup, you can give permission to Moderator, Vip or user to show the code in chat with "!room" command
56+
- **Multiplayer+:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#multiplayer-plus))
57+
- Basic features included like Quick Play, Server creation, Joining code and room finding with basic search
58+
- In the rooms, you can change room code, hide and show the code, play up to 20 people (40 with one patreon present)
59+
- 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
5560
- Custom Songs with BeatSaver support
5661
- ScoreSaber and BeatLeader support
57-
- Noodle & Chroma & 360/90 maps support
58-
- In game avatars & movement sync (Require a Patreon in the lobby)
62+
- Noodle/Chroma & 360/90 maps support
63+
- In game avatars & movement sync
64+
- An option inside the room to see/not see other player while playing included (arena)
65+
- **NoteTeaker:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#note-tweaker))
66+
- Profiles can be created and [ChatIntegrations](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-integrations) can switch it with your events
67+
- Changing any parts of notes like dots(with sliders or not), arrow, arcs, note or bomb scale
68+
- A preview of your changes is on the right panel
69+
- Hide/show dot on directional notes support
5970
- **SongChartVisualizer:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#song-chart-visualizer))
6071
- Preview map difficulty with a nice and beautiful graph in game that illustrate NPS (Notes per second).
6172
- Support for 90 & 360 levels.
6273
- Lot of customization options (Colors, Legend, Dash lines...).
6374

6475

65-
## Dependencies:
76+
## **Dependencies**
6677

6778
- SongCore [https://github.com/Kylemc1413/SongCore](https://github.com/Kylemc1413/SongCore)
6879
- BeatSaberMarkupLanguage [https://github.com/monkeymanboy/BeatSaberMarkupLanguage](https://github.com/monkeymanboy/BeatSaberMarkupLanguage)
6980

81+
## **Other questions? See the FAQ [Here](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-FAQ)**
82+
7083
## **Special Thanks**:
7184
- **Vred#0001** For art & documentation
7285
- **Brase#6969** For documentation
@@ -91,4 +104,4 @@ https://discord.gg/63ebPMC
91104
![](https://puu.sh/GKPcD/ecee2e5d86.png)
92105
![](https://puu.sh/GH9Rn/d9d4966a04.png)
93106
![](https://puu.sh/GH9RA/f6dc522cd1.png)
94-
![](https://puu.sh/GL7BX/0e5f12cfce.jpg)
107+
![](https://puu.sh/GL7BX/0e5f12cfce.jpg)

0 commit comments

Comments
 (0)