docs: add Installation section to README#25
Merged
Conversation
Co-authored-by: Brollyy <12004018+Brollyy@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add installation guide section to README
docs: add Installation section to README
Mar 4, 2026
Brollyy
approved these changes
Mar 4, 2026
There was a problem hiding this comment.
Pull request overview
Adds end-user installation guidance to the repository README so new users can install the mod without inferring setup steps.
Changes:
- Added an Installation section with a link to the official BepInEx 5.x install guide.
- Documented how to install
BopVisualEffects.dllinto<GameRoot>/BepInEx/plugins/and verify it by launching the game.
You can also share your feedback on Copilot code review. Take the survey.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README had no user-facing installation instructions — readers had to infer the setup steps.
Changes
README.md: Added## Installationsection immediately after the intro paragraph, before## Available effects, with:<GameRoot>/BepInEx/plugins/, and launch the game🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.