「どどんとふ」マニュアル

ALL YOU NEED IS THIS, on online TRPG session.

presented by たいたい竹流(taitai takeru)　from http://www.dodontof.com
-- modified BSD licenses

【注：どどんとふを初めて使う方へ】

どどんとふ解説書

どどんとふの使用方法については
　　
こちらの解説書を参照下さい。

このマニュアルではどどんとふの自前サーバの設置方法や技術的な観点について記載しています。

目次

• どどんとふ解説書
• 「どどんとふ」って何？
• 実行環境
• 使用方法
• 設置方法
  • CGIサーバの用意
    • レンタルサーバを用意する場合の注意事項
  • 自前サーバ運営者へのアドバイス
  • 実行ファイル一式のダウンロード
  • 設置方法その２：MySQLサーバ編
  • 動作確認方法
  • お知らせメッセージの変更
  • バージョンアップ方法
• 開発向けの詳細
  • コンパイル方法について
    • Adobe Flex SDKの準備
    • Rakeを使用したコンパイル
    • 手動コンパイル
  • ダイスボットの実装について
• WEB IFについて
  • WEB IFとは？
  • 基本フォーマット
  • getBusyInfo：サーバ負荷情報の取得
  • getServerInfo：サーバの各種情報取得
  • getRoomList：部屋情報一覧の取得
  • getLoginInfo：初期ログイン用データ取得
  • getLoginUserInfo：ログインユーザーの情報取得・更新
  • chat：チャットデータの取得
  • talk：チャットへの発言
  • getChatColor：文字色取得
  • addCharacter：キャラクター追加
  • changeCharacter：キャラクターの変更
  • getRoomInfo：プレイルーム情報取得
  • setRoomInfo：プレイルームの情報設定
  • addMemo：共有メモ追加
  • changeMemo：共有メモ追加
  • addMessageCard：メッセージカード追加
  • refresh：各種情報取得
  • uploadImageData：画像ファイルアップロード
• ライセンスについて
  • ファイル構成
  • ライブラリ・画像データ等について
    • キャラクター画像
    • 立ち絵画像
    • tubeloc
    • Hi-ReS-Stats
    • corelib
    • Archive::Tar::Minitar
    • as3-msgpack
    • msgpack-pure
    • msgpack-pure-ruby
    • simple-color-picker
    • 各種アイコン用画像集
    • サンプル用立ち絵
    • jsonParser.rb
    • flexlib
    • その他
• その他
  • 名前の由来について
• 注意事項
• 履歴

「どどんとふ」って何？

実行環境

使用方法

設置方法

CGIサーバの用意

まず、Rubyの動くCGIサーバが必要です。
サポートバージョンは以下の通り。

「どどんとふ」を動かすために必要なRubyのバージョン：1.8.7 以上

• Ruby 1.9を使用する場合は、CGIライブラリのバグが修正された1.9.3

この条件を満たさないと正常に動作させることはできません。

レンタルサーバを用意する場合の注意事項

• さくらインターネット（参照）7人程度までは負荷に問題なし。
• エックスサーバー（参照：10人未満での運用は問題なし。負荷が高すぎる場合は運営から通達があります）
  →Rubyのバージョンを変えるために、CGIのパスは「#!/usr/bin/ruby2.0.0」に変更願います。

• land.to（参照）
• Mover（参照）
• WISNET（Rubyが無いため動作不可）
• ファーストサーバー（Rubyが無いため動作不可）
• @PAGES（CGIに制限が掛かったりと問題が多発したため非推奨）
• エクストリムレンタルサーバー（Rubyのバージョンが1.8.5と古いためサポート対象外に）

自前サーバ運営者へのアドバイス

実行ファイル一式のダウンロード

• 「さくらインターネット」なら「2.2. プログラムのコマンドパス」
• 「エックスサーバー」なら「CGI関連の仕様一覧」
• 「エクストリムレンタルサーバー」なら「CGIのパス・パーミッションについて」（perlのパスをrubyに読み替えて下さい）

• 「さくらインターネット」なら「2.1. ファイル、ディレクトリの設定」
• 「エックスサーバー」なら「CGI関連の仕様一覧」
• 「エクストリムレンタルサーバー」なら「CGIのパス・パーミッションについて」

設置方法その２：MySQLサーバ編

#MySQLを使用する場合のDB設定。
$databaseHostName = "127.0.0.1"
$databaseName = "databaseName"
$databaseUserName = "user"
$databasePassword = "password"

#セーブデータの管理方法(nil/"mysql")
$dbType = nil

#セーブデータの管理方法(nil/"mysql")
$dbType = "mysql"

動作確認方法

お知らせメッセージの変更

バージョンアップ方法

###config_local.rb の記述例##
#サーバにログインする事のできる限界人数。
$limitLoginCount = 10

#プレイルームの最大数
$saveDataMaxCount = 5

#チャットの過去ログ大量保管を許可するかの設定
$IS_SAVE_LONG_CHAT_LOG = false

開発向けの詳細

コンパイル方法について

「どどんとふ」でコンパイルして作成する必要があるのはFlex（ActionScript）の生成ファイル
DodontoF.swf
のみです。

以下、コンパイル方法について述べます。

Adobe Flex SDKの準備

コンパイルにはAdobe Flex SDKが必要です。
http://sourceforge.net/adobe/flexsdk/wiki/Download%20Flex%203/
から 3.6.0.16995A の Adobe Flex SDK をダウンロードします。
ダウンロードファイルを展開後、binディレクトリへパスを通しておきます。

またJavaも必要なため、
http://www.oracle.com/technetwork/java/javase/downloads/index.html
から「JDK」（Java SE Development Kit）をダウンロードし、インストールしておきます。

Rakeを使用したコンパイル

Ruby 1.9以降がインストールされていて正しくパスが通されている場合は、Rubyに標準で添付されているビルドツールRakeを使用して簡単にコンパイルすることができます。
DodontoF ディレクトリで以下を実行すると、DodontoF.swf が DodontoF ディレクトリに生成されます。

rake swf

手動コンパイル

上記のRakeが使えない場合は、手動でコンパイルを行ってください。

DodontoF/src_actionScript ディレクトリで以下を実行します。
LinuxやOSXのようなUNIX環境では、mxmlc.exe を mxmlc に変えてください。

mxmlc.exe -target-player=10.0.12 -define=TEST::isTest,false -define=COMPILE::isReplayer,false -define=COMPILE::isMySql,false -include-libraries+=./corelib/bin/corelib.swc  -o ../DodontoF.swf DodontoF.mxml

これで DodontoF.swf が作成されるはずです。
作成された DodontoF.swf を DodontoF 直下に移動してください。

コンパイル方法は以上です。

上記以外はRubyのコードになりますのでファイルを直接編集してもらえれば反映されます。
ソースコードの内、〜Testで終わるファイルはUnitTest用ですので通常の運用では変更する必要はありません。

ダイスボットの実装について

WEB IFについて

WEB IFとは？

基本フォーマット

getBusyInfo：サーバ負荷情報の取得

getServerInfo：サーバの各種情報取得

getRoomList：部屋情報一覧の取得

getLoginInfo：初期ログイン用データ取得

getLoginUserInfo：ログインユーザーの情報取得・更新

chat：チャットデータの取得

talk：チャットへの発言

getChatColor：文字色取得

addCharacter：キャラクター追加

changeCharacter：キャラクターの変更

getRoomInfo：プレイルーム情報取得

setRoomInfo：プレイルームの情報設定

addMemo：共有メモ追加

changeMemo：共有メモ追加

addMessageCard：メッセージカード追加

refresh：各種情報取得

uploadImageData：画像ファイルアップロード

例）
HTML側：form部分から必須箇所のみ抜粋

        <form id="fileUpload">
          <canvas id="smallImageCanvas" ></canvas>
          <input type="file" id="fileData" name="fileData" accept="image/*" capture ><br>
          <input id="tags" placeholder="tags" />
          <button type="button" onclick="uploadImage()">画像アップロード</button><br>
        </form>

javascript側： 必須箇所のみ抜粋。

function uploadImage() {
    
    //jqueryを導入していることが前提です。
    // フォームデータを取得
    var formData = new FormData( $('form#fileUpload')[0] );//アップロードする画像の指定
    
    //縮小画像を取得。縮小画像をアップロード時に送信すると
    //「どどんとふ」本体の画像一覧に縮小画像が利用されるので動作が軽くなりユーザーに親切です。
    //ただ設定は手間なのも事実なので、指定を省略することも可能です。
    var canvas = document.querySelector('#smallImageCanvas');
    var base64Data = canvas.toDataURL('image/png');
    smallImageData = base64Data.replace('data:image/png;base64,', '');
    formData.append( 'smallImageData', smallImageData ); //縮小画像の指定（省略可能）
    
    formData.append( 'webif', "uploadImageData" ); //webifの指定
    formData.append( 'room', roomNo ); //部屋番号の指定
    if(roomPass != "" || roomPass == null){
        formData.append( 'password', roomPass ); //パスワードの指定
    }
    
    formData.append( 'tags', $('#tags').val() ); //タグ名の指定
    //formData.append( 'imagePassword', "パスワード" ); //絵のパスワードも指定できます（ここでは未使用）

    for(item of formData) {
        console.log(item);
    };
    
    
    var url = getServerUrl();

    // POSTでアップロード
    $.ajax({
        url  : url,
        type : "POST",
        data : formData,
        async: false,
        cache       : false,
        contentType : false,
        processData : false
    })
        .done(function(data, textStatus, jqXHR){
            $('#fileUploadResult').text( "result : " + data.result + ", fileName:" + data.fileName );
        })
        .fail(function(jqXHR, textStatus, errorThrown){
            alert("fail");
            console.log( 'ERROR', jqXHR, textStatus, errorThrown );
        });
}

ライセンスについて

ファイル構成

ライブラリ・画像データ等について

キャラクター画像

立ち絵画像

tubeloc

Hi-ReS-Stats

corelib

Archive::Tar::Minitar

as3-msgpack

msgpack-pure

msgpack-pure-ruby

simple-color-picker

各種アイコン用画像集

サンプル用立ち絵

jsonParser.rb

flexlib

その他

その他

名前の由来について

注意事項

履歴