MH-API (モンスターハンター API)

APIのエンドポイントは、こちら https://api.mh-api.com/v1

English version is here

MH-API は、モンスターハンターシリーズに関する攻略情報等を提供するオープンソースのプロジェクトです。このプロジェクトでは、モンスターハンターシリーズのプレイヤーがゲームの攻略情報等にアクセスし、二次創作やツール等の制作を簡単にできるようにするための API を開発しています。

はじめに

この README.md は、MH-API プロジェクトのガイドラインと使い方について説明します。以下のガイドラインに従ってプロジェクトに参加していただくことを歓迎します。

本プロジェクトにおける行動規範はこちら

Getting Started

MH-API プロジェクトに参加するためには、以下の手順に従ってください。

事前準備

• コントリビュートガイドを確認する。コントリビュートガイドはこちら

環境構築

1. リポジトリのディレクトリに移動

   cd MH-API

2. エディタでディレクトリを開く

3. 新規ブランチを作成する

       git checkout -b "[new branch]"

4. 動作確認する

        # dockerを立ち上げる
        make compose-start
   
        # DBをマイグレーションする
        make migrate-up
   
        # Seedデータを入れる
        make seed
   
        # {"message": "ok"}とレスポンスが返ること
        curl http://localhost:8080/v1/health

5. テストを実行する

       # 全てのテストがokとなること
       make test

コミュニティとコミュニケーション

本コミュニティではこちらの行動規範に従ってください。

MH-API プロジェクトに参加するには、以下のコミュニケーションチャンネルを利用できます。

• Slack チャンネル: slack.mhapi.org に参加して、他のコントリビューターやメンバーと交流しましょう。

• Issue トラッカー: MH-API Issue トラッカー を使用して、バグ報告や新しい機能の提案を行ってください。

ライセンス

MH-API プロジェクトは、MIT ライセンスのもとで公開されています。詳細なライセンス情報については、プロジェクト内の LICENSE ファイルをご確認ください。

貢献ガイドライン

MH-API プロジェクトへの貢献に関するガイドラインについては、CONTRIBUTING.mdを参照してください。プロジェクトにコードやドキュメントの貢献をする前に、ガイドラインをお読みください。

サポート

MH-API プロジェクトに関するサポートが必要な場合は、mhapiadm@gmail.comまでお問い合わせください。

API Spec

API doc

MonHun AI Agent 🤖

NEW! ADK Go（Agent Development Kit for Go）を使用したモンスターハンター攻略情報専用のAIエージェントを提供しています。

特徴

• Gemini APIを使用した自然言語での対話
• モンスター、武器、アイテム、スキル情報へのアクセス
• RESTful APIとして利用可能
• Cloud Run対応

詳細は AGENT.md を参照してください。

クイックスタート

# 環境変数を設定
export GEMINI_API_KEY=your_api_key_here
export DATABASE_URL=mh-api:P@ssw0rd@tcp(127.0.0.1:3306)/mh-api?charset=utf8&parseTime=True&loc=Local

# エージェントを起動
make run-agent

謝辞

このプロジェクトは、オープンソースコミュニティの貢献者や MH-API ユーザーのご協力によって成り立っています。多くの人々に感謝の意を表します。

このプロジェクトは、株式会社カプコンの商標および登録商標であるモンスターハンターシリーズ ™ を利用しています。モンスターハンターシリーズ ™ は株式会社カプコンの知的財産です。ここにカプコン様へ感謝の意を表します。

なお、このプロジェクトは非公式のものであり、株式会社カプコンとは関係ありません。

Happy coding!

References

https://opensource.guide/ja/starting-a-project/

this project has started from 2023/5/21