Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Nobody committed Dec 19, 2024
1 parent 0d67ca0 commit 9bb545c
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# DangerMods Plugin

An ExileCore2 plugin that plays an alert sound when dangerous rare monsters with specific modifiers are encountered.
An ExileCore2 plugin that alerts you to dangerous rare monsters with specific modifiers through both sound and visual alerts.

## Features

- Plays a customizable sound alert when encountering rare monsters with specific modifiers
- Displays dangerous monster names and their mods in a configurable screen position
- Configurable list of dangerous modifiers to watch for
- Adjustable alert volume
- Debug mode for troubleshooting
Expand All @@ -17,7 +18,12 @@ An ExileCore2 plugin that plays an alert sound when dangerous rare monsters with
- **Enable**: Toggle the plugin on/off
- **Sound Alerts**: Enable/disable sound alerts
- **Volume**: Adjust the alert volume (0-100)
- **Modifiers to Alert**: List of monster modifiers to watch for (comma or newline separated)
- **Modifiers to Alert**: List of monster modifiers to watch for (comma separated)
- **Alert Display**: Visual alert settings
- **Show Alert Text**: Toggle the on-screen text display
- **Display Position X**: Horizontal position of alerts (0-2000)
- **Display Position Y**: Vertical position of alerts (0-2000)
- **Font**: Font settings (e.g., "FrizQuadrataITC:16")
- **Debug Messages**: Toggle debug messages in the game overlay

### Default Dangerous Modifiers
Expand All @@ -39,15 +45,17 @@ You can customize this list in the settings to match your preferences.
## Usage

1. Enable the plugin in ExileCore
2. Enable Sound Alerts
3. Adjust the volume to your preference
4. Modify the modifier list if needed
5. Use the Play Alert button to test your volume settings
2. Configure both sound and visual alerts:
- Enable Sound Alerts and adjust volume if desired
- Position the text display where you want it on screen
3. Modify the modifier list if needed
4. Use the Play Alert button to test your sound settings

The plugin will automatically alert you when encountering rare monsters with any of the specified modifiers.
The plugin will automatically alert you when encountering rare monsters with any of the specified modifiers, both with a sound alert and by displaying the monster's name and dangerous mods on screen.

## Tips

- Position the text display where it won't interfere with important game information
- Keep the volume at a noticeable but not overwhelming level
- Add modifiers that are particularly dangerous to your build
- Use debug messages to verify the plugin is detecting modifiers correctly

0 comments on commit 9bb545c

Please sign in to comment.