Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
danong committed Sep 6, 2018
2 parents 111cba8 + 269faab commit 39f7967
Showing 1 changed file with 7 additions and 24 deletions.
31 changes: 7 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,22 @@ This mod displays the damage breakdown and DPS of your current team.

During hunts, this mod displays the percent of total team damage done and the [exponential moving average](https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average) of DPS of each player. After hunts, this mod displays the damage, percent of total team damage, and the overall DPS of each player.

Distributed on [Nexus Mods](https://www.nexusmods.com/monsterhunterworld/mods/105).


## Instructions

1. Run Monster Hunter: World
2. Run this mod and adjust the position and size of the overlay
1. Run Monster Hunter: World in borderless windowed mode
2. Run this mod and adjust the position/size of the overlay
3. Enjoy the hunt!

## Known Limitations/Bugs

- Post-hunt DPS is low because it includes the 60/20 seconds period after the hunt and the time spent in the post-hunt summary pages (possibly).
- Negative intial DPS values during hunts.

## Contributing Guide

Contributions are welcome. Feel free to make an issue or pull request. This project is licensed under the MIT license.
Contributions and forks are welcome. Please take a look at our Issues and Projects pages and feel free to make an issue or pull request. This project is licensed under the MIT license.

The minimum supported version of Visual Studio is 10.0.40219.1 but we recommend using 15.0.28010.2016 or later.

## Credits

[Original mod](https://www.nexusmods.com/monsterhunterworld/mods/88) by [hqvrrsc4](https://www.nexusmods.com/monsterhunterworld/users/7950104). Modified with permission.

## Todo

### Basic Functionality
- [x] Implement DPS calculation
- [x] Fix numbers for subsequent hunts
- [ ] Fix post hunt DPS calculation. Maybe store the last damage timestamp and use that as the end time for calculating overall DPS
- [ ] Fix negative values DPS values

### UI/UX
- [ ] Fix character clipping
- [ ] Improve overlay UI

### Misc.
- [ ] Publish to NexusMods
- [ ] Add a license to this repo
- [ ] Add more details and screenshots to the README

0 comments on commit 39f7967

Please sign in to comment.