Skip to content
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

Added blank spaces #12

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+13 −0
Open

Added blank spaces #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@


# monster-avengers - The MH4G/MH4U/MHX Armor Set Search Tool

## Introduction


This is a hobby project of mine, which impelements an algorithm and a web based UI that finds armor sets to satisfy certain requirements in the game [Monster Hunter 4 Ultimate](http://www.monsterhunter.com/) (Japanese Version: [Monster Hunter 4G](http://www.capcom.co.jp/monsterhunter/4G/)).

Monster Hunter has an unique skill system, and in order to active a certain skill, we need to craft a combination of armors including a weapon, a helmet, a body armor, a waist armor, an arm armor, a legs armor and an amulet, whose total contribution to the desired skill exceeds a skill points level. Finding the right set of armor pieces that activates the required skills is difficult, as there are ~ 150 different skill trees, ~ 600 candidate armors for each of the pieces, and each armor contributes to several skills, positively or negatively. What makes the problem more interesting is that armors may have slots, where different decorations contributing to different skills can be plugged in.
Expand Down Expand Up @@ -38,6 +42,7 @@ I am working on a [series of posts](http://blog.breakds.org/armor-up-the-algorit

## Codebase


For those who is interested in either the algorithm or the implementaion, you can find a brief description below. Note that the code is still not very well documented yet, and I am working on adding the comments and documentations to the code as much as possible with the limited time budget.

The code is mainly divided into 2 parts:
Expand All @@ -52,6 +57,8 @@ The code is mainly divided into 2 parts:

### Build and Run



The C++ code is managed by CMake. To build the C++ binary:
````
cd cpp/
Expand All @@ -77,6 +84,8 @@ to start the web server. You should now be able to access the web app locally at

## Limitations and Futrue Work



There are currently some limitations in the current implementations, and I will work on improve over them. Those that I am aware of are:

1. The webapp does not support custom guild armors.
Expand All @@ -93,6 +102,8 @@ There are currently some limitations in the current implementations, and I will

## Acknowledgement



1. Credit to Ping An, the author of [Ping's Dex](https://sites.google.com/site/pingsdex/pingsmh4gdex). His effort on composing the data are source to many other related projects.
1. Credit to the project [MonsterHunter4UDatabase](https://github.com/kamegami13/MonsterHunter4UDatabase), where all the data (armors, skills and decorations) are from their database. Completing the database requires a lot of work and without their effort, I would not have accomplished this.
2. Credit to Cassandra Qi, my wife and my Monster Hunter game partner, for working on the art and design of the UI.
Expand All @@ -106,6 +117,8 @@ There are currently some limitations in the current implementations, and I will

## License



All the codes in this project are under the MIT License.


Expand Down