睡工房

【RGSS3】* SuitterVXAce *


◇ 機能説明

ゲーム内でTwitter認証処理を行い、直接Twitterへ投稿する機能を実装します。

また認証したユーザのプロフィールやアイコンをゲーム内で使用する事ができます。

投稿する文章にはRPGツクール標準の制御文字が使用可能です。

※使用可能制御文字:\V[n] \N[n] \P[n] \G \U[n]

※制御文字拡張素材により増える場合があります。

※\U[n]はSuitterVXAceの拡張制御文字です。


画像については1枚まで添付して投稿することができ、スクリーンショットと任意画像の投稿に対応しています。

※画像投稿は1〜2秒ほどゲームが停止します(画像処理と通信が重い…)

【重要】RGSS3「すいったー」と同時使用はできません。


◇ 利用シーン

・ユーザ認証型ゲーム

・ゲーム進捗の共有

・実績画面の共有

・クリア報告の共有

・獲得スコアの共有etc


◇ スクリーンショット

イベントサンプル1 イベントサンプル2 イベントサンプル3 イベントサンプル4 投稿結果 認証画面


◇ ダウンロード

SuitterVXAceはセキュリティ向上のため、サーバーで毎回重要情報を暗号化しています。

下の入力フォームに必要事項を入力して、send ボタンを押して下さい。

Consumer Key と Consumer Secret の入手方法→TwitterApplicationCreate.pdf

※アプリ登録後、認証出来るようになるまで時間がかかる場合があります。

TwitterAPI Consumer Key(API Key)

TwitterAPI Consumer Secret(API Secret)

【お願い】send ボタンで新規に生成したスクリプトをご自身のゲームで使用して下さい。


◇ 導入方法

1.「▼ 素材」セクション以下の自由な位置に導入して下さい。


◇ 動作サンプル

【重要】この動作サンプル内のスクリプトの本番転用を禁止します。
必ずご自身にてTwitterのアプリ登録を行い、上記のダウンロードでご自身のアプリキーから生成したスクリプトをご利用下さい。
サンプルのアプリキーは予告なく変更する場合があります。

SuitterVXAce.zip


◇ スクリプトからの使用方法

□ 投稿

書式1: Suitter.post(text)         テキストのみ投稿

書式2: Suitter.post(text, :screenshot)  スクリーンショット付き投稿

書式3: Suitter.post(text, path)      任意画像付き投稿

      ※path には「Game.exe」があるフォルダからの相対パスで指定して下さい。

       例:「Graphics/Pictures」フォルダに「sample.png」ファイルがある場合

         Suitter.post("aiueo", "Graphics/Pictures/sample.png")


※制御文字は以下のものを使用できます。(「\」は2つ必要です。)

\\V[n] \\N[n] \\P[n] \\G \\U[n]


※改行したい場合は「\n」を使用してください。

※投稿テキストが長く、スクリプトの1行に入らない場合は変数を利用して下さい。

例)

a = "あいうエリー!"

b = "まみむメリー!"

Suitter.post(a + "\n" + b)

□ 付随データ修正

Suitter.data[tag] = "data"

tag には以下のものを使用できます。

:url投稿テキストに追加させたいURL

:hashtags投稿テキストに追加させたいハッシュタグ

□ 付随データのリセット

Suitter.reset

□ 認証の開始

Suitter.start_authorize


このコマンドを実行すると、アプリの認証許可画面がブラウザで開きます。

ここで認証した場合に表示されるPINコードを入力するようにプレイヤーを誘導して下さい。

□ 認証の再開

Suitter.resume_authorize(var_num)

  var_num : PINコードが入力されているゲーム変数のID


「数値入力の処理」等のコマンドでプレイヤーにPINコードを入力して貰ったら、

PINコードを保存しているゲーム変数のIDを指定してこの命令を実行して下さい。

□ 認証状態の確認

Secret.authenticated?


認証されているか、されていないかを「true/false」で返します。

「条件分岐」コマンドの「スクリプト」に記述して、イベントを分岐させて下さい。

□ 認証状態の解除

Secret.deauthorize


認証状態を解除します。

「スクリプト」コマンドに記述して下さい。

□ 認証ユーザのプロフィール取得

User[:key]

  :key : 欲しい情報のキー


# ()内は作者のプロフィールの場合です

User[:id] ... ユーザーID (103371596)

User[:screen_name] ... ユーザーの表示名 (@satonayu)

User[:name] ... ユーザーのプロフィール名(さとちー)

User[:location] ... 現在地 (夢の中)

User[:description] ... 自己紹介的な部分 (RGSS2と3の素材…)

User[:url] ... URL (http://hime.be/)

User[:followers] ... フォロワー数 (692)

User[:friends] ... フォロー数 (722)

User[:listed] ... リストされてる数 (26)

User[:favourites] ... いいね件数 (2929)

User[:posted] ... ツイート数 (36087)

User[:image] ... プロフィール画像のURL (https://pbs.twimg.com...)


◇ 注釈コマンドからの使用方法

□ 投稿

・書式1:テキスト投稿

<suitter_post>

あいうエリー!

まみむメリー!


・書式2:スクリーンショット付き投稿

<suitter_post :screenshot>

あいうエリー!

まみむメリー!


・書式3:任意画像付き投稿

<suitter_post path>

あいうエリー!

まみむメリー!

      ※path には「Game.exe」があるフォルダからの相対パスで指定して下さい。

       例:「Graphics/Pictures」フォルダに「sample.png」ファイルがある場合

         <suitter_post Graphics/Pictures/sample.png>


※制御文字は以下のものを使用できます。

\V[n] \N[n] \P[n] \G \U[n]


□ 付随データ修正

<data tag data>

tag には以下のものを使用できます。

:url投稿テキストに追加させたいURL

:hashtags投稿テキストに追加させたいハッシュタグ

□ 付随データのリセット

<suitter_reset>

□ 認証の開始

<suitter_start_authorize>


このコマンドを実行すると、アプリの認証許可画面がブラウザで開きます。

ここで認証した場合に表示されるPINコードを入力するようにプレイヤーを誘導して下さい。

□ 認証の再開

<suitter_resume_authorize var_num>

var_num : PINコードが入力されているゲーム変数のID

「数値入力の処理」等のコマンドでプレイヤーにPINコードを入力して貰ったら、

PINコードを保存しているゲーム変数のIDを指定してこの命令を実行して下さい。

□ 認証状態の解除

<suitter_deauthorize>


認証状態を解除します。


◇ 拡張制御文字

□ 認証ユーザのプロフィールに置き換え

\U[n]

  n には 0~の数字を指定して下さい。

()内は作者のプロフィールの場合です

\U[0] ... ユーザーID (103371596)

\U[1] ... ユーザーの表示名 (@satonayu)

\U[2] ... ユーザーのプロフィール名(さとちー)

\U[3] ... 現在地 (夢の中)

\U[4] ... 自己紹介的な部分 (RGSS2と3の素材…)

\U[5] ... URL (http://hime.be/)

\U[6] ... フォロワー数 (692)

\U[7] ... フォロー数 (722)

\U[8] ... リストされてる数 (26)

\U[9] ... いいね件数 (2929)

\U[10] ... ツイート数 (36087)

\U[11] ... プロフィール画像のURL (https://pbs.twimg.com...)


◇ 認証ユーザのアイコン画像の扱いについて

□ イベントコマンド「ピクチャの表示」

1.「Graphics/Pictures」というフォルダに「TwitterUser.png」というダミー画像を保存して下さい。

2.イベントコマンド「ピクチャの表示」で「TwitterUser」を指定して下さい。

3.認証済みであればアイコン画像が、未認証であればダミー画像が画面に表示されます。


◇ エラーへの対応

□ エラーの確認方法

スクリプトの設定項目「ERROR_DISPLAY」を「true」にしている場合、画面にエラーメッセージが表示されます。

スクリプトの設定項目「ERROR_LOG_FILE」を「true」にしている場合、「Suitter」というフォルダにエラーメッセージが保存されます。

□ エラーと原因・対処方法

確認したエラーコードやメッセージを元に、以下のリンク先で確認してください。

SuitterVXAceエラー詳細


◇ スペシャルサンクス(順不同)

□ 技術提供

Ruたん様鳥小屋.txt

□ 動作検証

がんてつ様ツクールのページ

タクポン様BLACK PANDA【R-18】

古城こじょ様おこじょの缶詰。

とりあか様エトリエ

イギリス紳士様ぱっくりパラダイスのBlog【R-18】

黒崎 綾人様YFK Project OFFICIAL SITE

SBR様SBR.net


◇ 更新履歴

2016.06.11 公開開始