MonsterHunter Rise Assistant

MonsterHunter Rise Assistant

Monster Hunter Rise Assistant is a Discord bot that provides you informations about Monster Hunter Rise monsters.
Click here to add this Bot to your guild

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

MonsterHunterRise Assistant uses built-in Discord Slash Commands in order to respond to the users requests.

All information about monster are stored in monsters.json, file createtd taking informations from Kiranico.

For example:

Then insert the monster name

Built With

• Visual Studio Code
• NodeJS

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Git
• Visual Studio
• NodeJS

Installation

1. Install Git at Download Git.
2. Clone the repo.

   git clone https://github.com/Federicoand98/MonsterHunterRise_Assistant

3. Install the latest version of NodeJS.
4. Open the directory with Visual Studio.
5. Unzip the 7z file in the Resources folder.

Usage

To use the application:

• Create the Discord bot with Discord Developer Portal and copy the token
• Move to the project folder

  cd MonsterHunterRise_Assistant

• Create your .env file This .env file is necessary for the bot's token and ID, inside the file paste

  TOKEN=paste_here_your_bot_token
  BOTID=paste_here_your_bot_id

• Install the following packages with npm package manager

  npm install dotenv
  npm install discord.js
  npm install @discordjs/builders @discordjs/rest discord-api-types

• Run with:

  node src/index.js

Roadmap

See the open issues for a list of proposed features (and known issues).

Future developments

• [] Creating a new json db file for weapon informations
• [] Creating a new json db file for armor and skills
• [] Creating a new json db file for quests
• [] Give the possibility to retrieve weapon, armor and quests information
• [] New command that calculate the best weapon and element against monster requested

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Federico Andrucci - federico.andrucci@gmail.com

Project Link: https://github.com/Federicoand98/MonsterHunterRise_Assistant