Skip to content

Commit 08097d1

Browse files
authored
Update README.md
1 parent c26a224 commit 08097d1

File tree

1 file changed

+54
-85
lines changed

1 file changed

+54
-85
lines changed

README.md

Lines changed: 54 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -6,93 +6,73 @@
66
**[READ THE PATCH NOTES ! 🥖](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Patchnotes)**
77

88
Current version : 6.0.8
9+
910
BeatSaber compatibility : 1.25.0 to 1.29.1 AND 1.31.0
1011

1112
**Important:** Most modules are disabled by default. Enable them in BeatSaberPlus -> Settings.
1213
* If you enable the Chat module, it will open a page in your browser for configuration.
1314
* 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.
1415

1516
## 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, follows, raids, bits events and channel redeems (channel points).
21-
- Twitch-specific features include Polls, Predictions (bets) and HypeTrains.
17+
- **Chat:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Chat))
18+
- Kick/Twitch/Youtube chat support.
19+
- 7TV/FFZ/BTTV Emotes support
20+
- See subs, follows, raids, bits and channel redeems
21+
- Polls, Predictions and HypeTrains.
2222
- Viewer count.
23-
- Hide messages started with "!"
24-
- Lots of customization options (colors, sizes, filter TTS messages, hide specific events and more).
25-
- **ChatEmoteRain:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-emote-rain))
26-
- See emotes used in chat raining in-game.
27-
- Support for **GIF / APNG / PNG / WEBP** files.
28-
- Custom emote rain when someone subscribes to your Twitch channel.
29-
- Advanced configuration options.
30-
- **ChatIntegrations:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-integrations))
31-
- Perform various actions with events.
32-
- Events can use -> **Chat events / Level status / VoiceAttackCommands (plugin installation required)**
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 allows viewers to make requests using the [https://beatsaver.com/](https://beatsaver.com/) website.
37-
- Displays information about all difficulties for a song including NPS/Offset.
38-
- Displays song description, votes, upload date when you select a song.
39-
- Displays score on songs when you hover over one.
40-
- User, Mapper, Song ban system
41-
- Safe mode that hides any sensitive information (song name, artist, uploader, etc.)
42-
- History & blacklist tab that lets you see your request history and manage your blacklist.
43-
- **An intelligent "!link" command that shows the current played song or last one and provides a link to beatsaver.com if the map is public. The command also works outside of request and in multiplayer!**
44-
- **You can find other useful commands 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, cut particles, obstacle particles, floor burn particles, floor burn effects, saber clash particles and world particles even with Liv capture.
47-
- Offers precise reaction time (AKA offset) selection.
48-
- Provides an option to override light intensity and boost/dim lights from 0% to 2000% (also works in static lights).
49-
- Can remove BTS/LinkinPark assets in a play environment, FullCombo loss animation, Editor button on the main menu, and promotional content from the menu.
50-
- Allows re-ordering player options menu for better accessibility.
51-
- Automatically cleans all old logs entry from your game folder to keep it clean.
52-
- Adds keyboard bindings to pause/continue/restart/exit a song in FPFC mode.
53-
- **MenuMusic:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#menu-music))
54-
- Replaces menu ambient sounds with music!
55-
- Plays any songs from your custom levels or your own selection of music!
56-
- Shows player interface in the menu on the left with Prev/Random/Play/Pause/Next buttons and with a volume selector.
57-
- Provides a play button to play the current song level.
58-
- **Multiplayer+:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#multiplayer-plus))
59-
- Basic features included like Quick Play, Server creation, Joining code and room finding with basic search
60-
- In the rooms, you can change the room code, hide and show the code, play up to 20 people (40 with one Patreon present)
61-
- 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 not
62-
- Custom Songs with BeatSaver support
63-
- ScoreSaber and BeatLeader support
64-
- Can disable your score submission
65-
- Noodle/Chroma & 360/90 maps support
66-
- In-game avatars & movement sync
67-
- An option inside the room to see/not see other players while playing included
68-
- **NoteTweaker:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#note-tweaker))
69-
- Create profiles and switch them using [ChatIntegrations](https://github.com/hardcpp/BeatSaberPlus/wiki#chat-integrations)
70-
- Modify different parts of notes, such as dots (with or without sliders), arrows, arcs, notes and bombs scale
71-
- Preview changes in a right panel
72-
- Supports hiding/showing dots on directional notes
73-
- **SongChartVisualizer:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#song-chart-visualizer))
74-
- Preview map difficulty with a graph that shows NPS (Notes Per Second) in-game
75-
- Supports 90 & 360 levels
76-
- Offers various customization options (Colors, Legend, Dash lines...)
77-
- **SongOverlay:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki#song-overlay))
78-
- Send game information to some overlays that are compatible with BS+
79-
- Game version
80-
- Game status (menu, playing)
81-
- Map info before playing a map
82-
- Pause or resume events
83-
- Score events (JSON format)
84-
85-
86-
## **Dependencies**
23+
- Lots of customization options
24+
- **ChatEmoteRain:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Chat-Emote-Rain))
25+
- See emotes used in chat raining in-game
26+
- Support for GIF / APNG / PNG / WEBP files
27+
- Custom emote rain when someone subs
28+
- Advanced configuration options
29+
- **ChatIntegrations:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Chat-Integrations))
30+
- Script and automatize your game with powerfull integrations
31+
- Control your game and mods
32+
- Control your OBS instance
33+
- Interact and control your games
34+
- Voice commands with VoiceAttack
35+
- **ChatRequest:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Chat-Request))
36+
- Let the viewers request their favorite map!
37+
- A powerfull !link command that let your viewers known what map you are playing
38+
- History and Blacklist support
39+
- Commands for moderation
40+
- OBS overlay
41+
- **GameTweaker:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Game-Tweaker))
42+
- Customize game visuals and effects!
43+
- Precise reaction time and player height
44+
- Change the light intensity of any map
45+
- Improve base game UI
46+
- **MenuMusic:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Menu-Music))
47+
- Replaces menu ambient sounds with music!
48+
- Plays any songs from your custom levels or your own selection of music
49+
- Controllable player interface with songs covers
50+
- A command for viewers to get info about the current song
51+
- **Multiplayer+:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Multiplayer-Plus))
52+
- A better multiplayer with custom songs support!
53+
- BeatLeader and ScoreSaber support!
54+
- Chroma, Noodle, 360, 90 maps support
55+
- See players avatar
56+
- Democracy and FFA mode
57+
- **NoteTweaker:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Note-Tweaker))
58+
- Complete customisation of the game notes and bombs with multi profile system!
59+
- Precision dots feature
60+
- Haptics and Arcs customisation
61+
- **SongChartVisualizer:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Song-Chart-Visualizer))
62+
- Preview map difficulty with a graph that shows NPS (Notes Per Second) in-game!
63+
- Supports 90 and 360 levels
64+
- Lots of customization options
65+
- **SongOverlay:** ([Documentation](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Song-Overlay))
66+
- Let your viewers known in real time your progress and score during a map
67+
- Multiple free OBS overlays made by the community
68+
69+
## **Dependencies & Licenses**
70+
### **[Licenses](https://github.com/hardcpp/BeatSaberPlus/wiki#licenses)**
8771

8872
- SongCore [https://github.com/Kylemc1413/SongCore](https://github.com/Kylemc1413/SongCore)
89-
- BeatSaberMarkupLanguage [https://github.com/monkeymanboy/BeatSaberMarkupLanguage](https://github.com/monkeymanboy/BeatSaberMarkupLanguage)
90-
9173

9274
### **[How to install](https://github.com/hardcpp/BeatSaberPlus/wiki#2---How-to-Install)**
93-
9475
### **[See the FAQ](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-FAQ)**
95-
9676
### **[READ THE PATCH NOTES ! 🥖](https://github.com/hardcpp/BeatSaberPlus/wiki/%5BEN%5D-Patchnotes)**
9777

9878
## **Special Thanks**:
@@ -102,17 +82,6 @@ BeatSaber compatibility : 1.25.0 to 1.29.1 AND 1.31.0
10282
- **Lucy#9197** For documentation
10383
- **redegg89#9290** For Documentation syntax/grammar
10484

105-
## **Discord & Download/Update**
106-
https://discord.gg/63ebPMC
107-
108-
## **Credits / Copyright**
109-
* [EnhancedStreamChat-v3](https://github.com/brian91292/EnhancedStreamChat-v3)
110-
* [TournamentAssistant](https://github.com/MatrikMoon/TournamentAssistant)
111-
* [Beat-Saber-Utils](https://github.com/Kylemc1413/Beat-Saber-Utils)
112-
* [BeatSaverDownloader](https://github.com/Kylemc1413/BeatSaverDownloader)
113-
* [BeatSaberMarkupLanguage](https://github.com/monkeymanboy/BeatSaberMarkupLanguage)
114-
* [websocket-sharp](https://github.com/sta/websocket-sharp)
115-
11685
## **Screenshots**
11786
![](https://puu.sh/GO6tf/81ff167aab.png)
11887
![](https://puu.sh/GKKJJ/7a481941c5.png)

0 commit comments

Comments
 (0)