improve readme

main
Bryce Allen 11 years ago
parent 573107480d
commit 156eec0b4c

@ -1,7 +1,9 @@
= Monster Hunter scripts = Monster Hunter scripts
This repository contains scripts for calculating probabilities and expected This repository contains the source code for http://mhapi.info, a site for
values for rewards and carves in Monster Hunter games. monster hunter related calculators and tools. It also contains scripts that
can be used directly from the command line, and python modules that can be used
to build other monster hunter related tools.
== Dependencies == Dependencies
@ -13,28 +15,20 @@ in all Python distributions (e.g. for Windows or Mac OS X).
The bundled monster hunter db is from the excellent The bundled monster hunter db is from the excellent
link:https://github.com/kamegami13/MonsterHunter4UDatabase[MonsterHunter4UDatabase] link:https://github.com/kamegami13/MonsterHunter4UDatabase[MonsterHunter4UDatabase]
Android app by DavianCorp, which is also MIT licensed. See db/COPYING.mh4udb Android app by DavianCorp, which is also MIT licensed. See
for license details. link:db/COPYING.mh4udb[] for license details.
== Example usage == Example usage
For a list of quests providing the specified monster part: For a list of quests and hunts providing the specified monster part:
bin/mhrewards.py "Zinogre Jasper" bin/mhrewards.py "Zinogre Jasper"
This gives expected values for the item from different sources, including This gives detailed expected values for the item from different sources,
quest rewards, carves, capture, and shiny drops. An expected value of including quest rewards, carves, capture, and shiny drops. It also gives
8% means that on average, you would get 8 of the item from 100 quests. Note recommendations for which quests and strategy (capture or kill) will give the
that this is different from the probability of getting at least one, which best results. See link:RECOMMENDATIONS.adoc[] for a more detailed explanation of
will be lower and is a pain to calculate when there can be different number the output.
of rewards. It also takes into account Carving and Luck skills. The main
value shown assumes no food or armor skills. For Carves the extra values
listed on the right are for felyne skills Carver Lo, Carver Hi, then armor
skills Carving Master and Carving God. For quest rewards the extra values
are for food/armor skills Lucky Cat/Good Luck and Ultra Lucky Cat/Great Luck.
The totals at the end list the range from no skills to the best skill. For
capture rewards the extra values are for armor skills Capture Expect, Master,
and God.
For more manual calculations, mhprob.py can be used directly. The quest For more manual calculations, mhprob.py can be used directly. The quest
"Plain Dangerous" in 3U has 2 fixed rewards in A, one in B. Diablos hardhorns "Plain Dangerous" in 3U has 2 fixed rewards in A, one in B. Diablos hardhorns

Loading…
Cancel
Save