概要

RPGアツマール リファレンスは、RPGアツマールで提供しているゲーム開発情報をまとめたポータルサイトです。

サーバー機能と連携しゲームを拡張できる「ゲームAPI」や、そのゲームAPIを簡単に使える「プラグイン」、ローカルでの作業をしやすくする「デバッグツール」、コミュニティ版コアスクリプトなどを提供しています。

API提供期間について

RPGアツマールはご投稿いただいたゲームの長期的な公開を前提として運用しています。しかし、ゲームは動画などと異なりブラウザ環境やサーバー環境により動作しなくなることがあります。やむを得ない理由によりAPIの公開を停止することがあります。

API・プラグインの公開を停止する場合は、基本的には停止の3ヶ月以上前RPGアツマールTwitterお知らせ等を通して告知するものとします。どのAPIもできるだけ長く提供するポリシーではありますが、ご理解いただけますと幸いです。

experimental の廃止

メソッドに experimental と入っている実験的機能という意味の表記が廃止となりました。 これまでの experimental メソッドも引き続き利用できますが、可能な限り、新しいメソッドに呼び換えをお願いします。

利用ガイドライン

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

目次

各機能解説

RPGアツマールで提供しているゲームAPIの機能解説ページです。その機能がどういったもので、なにができるものなのかを解説しています。

用語の意味や、設定方法などもここに記載されています。

具体的な利用方法については、用途に合わせて、各機能のプラグインでの利用方法及び、APIでの利用方法をご参照ください。

プラグインでの利用方法

プラグインでの利用方法では、ゲームAPI を簡易に利用できるようにしたプラグインについて解説しています。

ゲーム内で利用したい機能のプラグインファイルを読み込み、設定することでゲームAPIが利用できます。

プラグインを利用する際には、RPGツクールMVのプロジェクトフォルダ内 js > plugins の中に利用したいプラグインを配置し、RPGツクールの上部メニュー[ツール]で利用したいプラグインを読み込んでください。

ツクールユーザーの方は、主にこちらをご利用ください(一部、プラグインがない機能もあります)。

APIでの利用方法

APIでの利用方法では、RPGツクールMV以外のゲームエンジンや、より高度な利用を必要とするユーザー向けに ゲームAPIの利用方法を解説しています。

APIとは「アプリケーションプログラミングインターフェース」の略で、RPGアツマールで利用いただけるプログラム機能のことです。

このAPIはアップロードされたゲームの index.htmlrpgatsumaru.js を挿入することで実現しています。

一般ドキュメント

やりたいことから探せる「逆引き索引」や、「FAQ」などの一般的な情報をまとめています。

共通事項

リクエスト制限などのようなゲームAPIを利用するにあたって把握しておくべき、共通事項をまとめています。

ゲームAPIを利用される際は、利用の前に必ずこちらの内容をご確認ください。

リソース

ゲーム開発のサポートを目的に、サンプルゲームのプロジェクトファイル、ゲーム制作向け素材、公式プラグイン、コミュニティ版コアスクリプト、APIデバッグツールなどを提供してます。

最終更新日

  • 2020/03/10

提供ドキュメント

ドキュメント概要
プレイヤー間通信の有効化特定のプレイヤー間でデータをやり取りできるAPIに必要なプレイヤー間通信の有効化について
コントローラーバーチャルコントローラーからの入力を受け取る機能について
マスターボリュームマスターボリュームの調整をする機能について
スクリーンショットのシェアゲームのスクリーンショットを撮影し、Twitterに投稿することができる機能について
サーバーセーブゲーム内のデータをセーブしたり、セーブしたデータを取得できる機能について
コメントユーザー同士でゲーム体験を共有できるコメント機能について
スコアボードゲームのスコア(点数)を記録・取得する機能について
外部リンク表示外部リンク表示機能について
クエリ情報取得URLクエリ情報を取得する機能について
作者情報表示ゲームの作者情報を表示する機能について
ニコニ広告情報取得プレイ中のゲームのニコニ広告情報を取得する機能について
ユーザー情報取得プレイヤー自身のユーザー情報や、他のプレイヤーのユーザー情報を取得する機能について
グローバルサーバー変数プレイヤー共通の変数を扱えるグローバルサーバー変数機能について
共有セーブ特定のサーバーセーブデータを取得する機能について
シグナルプレイヤー間でデータ(信号)をやり取りできる機能について
ギフトプレイ中のゲームのギフト情報を取得する機能について
プラグインでの利用方法プラグインでの利用方法
APIでの利用方法APIでの利用方法
一般ドキュメント一般ドキュメントトップ
共通事項RPGアツマール ゲームAPI共通の決まりごとについて
リソースRPGアツマールに関するプラグイン・デバッグツール・素材・サンプルゲームなどのリソースのダウンロードについて

更新履歴

日時内容
2020/10/30ギフトAPIを追加
2020/10/30コメントgposシステムにv2を追加
2020/10/15RPGツクールMZ対応プラグインを追加
2020/02/26全体の再整理
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初版作成
Better site: ProxyBot webproxy https://proxybot.cc/b?q=2knBCokFC8UXndCj8X6SkTXVFuIuFuisuBS