Skip to content

docs: add Installation section to README #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Brollyy merged 2 commits into from
Mar 4, 2026
Merged

docs: add Installation section to README #25

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
950dcf9
Initial plan
Copilot Mar 4, 2026
dfb7282
docs: add Installation section to README
Copilot Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

BepInEx 5.x mod for Bits & Bops that adds additional visual effects for the in-game editor.

## Installation

1. Install [BepInEx 5.x](https://docs.bepinex.dev/articles/user_guide/installation/index.html) for Bits & Bops.
2. Download `BopVisualEffects.dll` from the [latest release](https://github.com/Brollyy/BopVisualEffects/releases/latest).
3. Place `BopVisualEffects.dll` in `<GameRoot>/BepInEx/plugins/`.
4. Launch the game — effects will be available in the in-game editor.

## Available effects

See [this document](docs/effects/README.md) for the full list of effects this mod enables.
Expand Down