概要

このドキュメントでは、RPGアツマールで利用できる公式プラグイン・APIの使い方を説明しています。

RPGアツマール 公式プラグインとは何か

  • 『RPGアツマール 公式プラグイン』は、RPGアツマール内のゲームが利用できる機能をまとめたJavascriptのファイル群です。
  • ゲーム内に利用したい機能のJavascriptファイルを読み込み、設定することでRPGアツマールの公式機能が利用できます。
  • プラグインを利用する際には、RPGツクールMVのプロジェクトフォルダ内 js > plugins の中に利用したいプラグインを配置し、RPGツクールの上部メニュー[ツール]で利用したいプラグインを読み込んでください。

RPGアツマール ゲームAPIとは何か

  • 『RPGアツマール ゲームAPI』はゲームからRPGアツマールの機能を利用するためのものです。
  • APIとは「アプリケーションプログラミングインターフェース」の略で、RPGアツマールで利用いただけるプログラム機能のことです。
  • このAPIはアップロードされたゲームの index.html に rpgatsumaru.js を挿入することで実現しています。

提供期間について

  • RPGアツマールはご投稿いただいたゲームの長期的な公開を前提として運用しています。しかし、ゲームは動画と異なりブラウザ環境やサーバー環境により動作しなくなることがあります。我々も、やむを得ない理由によりAPIの公開を停止することがあります。
  • API・プラグインの公開を停止する場合は、基本的には「停止の3ヶ月以上前に」Twitterお知らせ等を通して告知するものとします。どのAPIもできるだけ長く提供するポリシーではありますが、ご理解いただけますと幸いです。
  • メソッドにexperimentalと入っているAPIは、実験的機能となります。API自体の廃止や、大幅な仕様変更の可能性があります。正式採用となった場合は、メソッドが変更されますので、その機能の利用を続ける場合は、呼び換えをお願いいたします。

公式プラグイン・API利用ガイドライン

  • 公式プラグイン・APIの利用によるサーバーへのネットワークアクセスは負荷を避けるために基本的に「10秒に1回」より緩やかにしてください。
  • ユーザーアクションによる短期的なアクセスは許容します。
  • オートセーブのような定期的にサーバーアクセスを行う処理は、「ゲームを長時間プレイしていないとき」に行わないようにしてください。
  • 公式プラグイン・APIはゲームプレイのために提供しています。ゲームに関係ないデータアクセスのために利用しないでください。

旧リファレンスについて

一部の情報はまだこちらのリファレンスに情報移行できていません。以下の情報をお探しの方は、 こちらの旧リファレンスも合わせて参照してください。

  • StorageAPI
  • ControllerAPI
  • CommentAPI
  • VolumeAPI

提供機能一覧

API概要
作者情報を表示するRPGアツマールのゲームの作者情報が記載されたダイアログを表示することができます。
クエリ情報の取得RPGアツマールでURLのquery情報を取得するにはこの機能を利用します。
外部リンクを表示するRPGアツマールで外部リンクを設置したい場合は、専用のダイアログを開いてダイアログ内で外部リンクを表示します。
スコアボードを利用するRPGアツマール内で動作するゲームのスコア(点数)を記録・取得できる仕組みです。
エラーハンドリングRPGアツマールのAPIが返すエラーについてのリファレンスです。

更新履歴

日時内容
2018/09/05初版作成