概要

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

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

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

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

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

提供期間について

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

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

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

提供機能一覧

API概要
★ 共通事項RPGアツマール ゲームAPI共通の決まりごとについてです。
コメントを利用するRPGアツマールのコメント機能を利用するにはCommentAPIを利用してください。
コントローラーを利用するスマートフォンでのゲームプレイ時に、バーチャルコントローラーからの入力を受け取るためのAPIです。
セーブを保存するセーブ機能を利用するにはStorageAPIを利用してください。
マスターボリュームの設定マスターボリュームの調整を行うにはVolumeAPIを利用してください。
外部リンクを表示するRPGアツマールで外部リンクを設置したい場合は、専用のダイアログを開いてダイアログ内で外部リンクを表示します。
クエリ情報の取得RPGアツマールでURLのquery情報を取得するにはこの機能を利用します。
作者情報を表示するRPGアツマールのゲームの作者情報が記載されたダイアログを表示することができます。
スコアボードを利用するRPGアツマール内で動作するゲームのスコア(点数)を記録・取得できる仕組みです。
スクリーンショットをシェアするプレイ中のゲームのスクリーンショットを撮影し、Twitterに投稿することもできる「スクリーンショットモーダル」の表示を行います。
グローバルサーバー変数RPGアツマール上で動作するグローバルサーバー変数です。
共有セーブを利用するRPGアツマール内で動作する特定のサーバーセーブデータを取得するAPIです
ユーザー情報にアクセスするプレイヤー自身のユーザー情報や、他のプレイヤーのユーザー情報にアクセスできます。
シグナルを送信するゲーム内で、他のユーザーと小さなデータ(信号)をやり取りするためのAPIです。
ニコニ広告情報を取得するプレイ中のゲームに関するニコニ広告情報を取得します。
▼ 関連リソースをダウンロードするRPGアツマールに関するプラグイン・デバッグツール・素材・サンプルゲームなどのリソースのダウンロード元をまとめています。

更新履歴

日時内容
2019/10/04Atsumaru Debugger へのリンクを追加
2019/07/22ニコニ広告情報取得APIを追加
2019/07/18定期実行トリガーの追加
2019/07/11オンライン人数APIを追加
2019/06/27外部リンクAPIの機能追加
2019/06/25グローバルサーバ変数の文字列型、新トリガー、名前での呼び出し等の情報を追加
2019/06/07ツイートAPIのサンプルゲームを追加
2019/05/31ツイート内容差し替えAPIを追加
2019/04/25リソースダウンロードページの追加
2019/03/18セーブAPIの仕様を現状に合わせた内容に修正
2019/03/13スコアボード取得APIにuserIdを追加
2019/03/06グローバルサーバー変数一括取得APIの説明を追加
2018/12/17共通事項、 グローバルサーバー変数APi、共有セーブAPI、シグナルAPI、ユーザー情報取得APiなどを追加
2018/10/25旧リファレンスを統合
2018/09/05初版作成