オンセンルーム -設置・解説ページ-

Copyright (c) 2018 ぽん太＠番頭

Released under the MIT license

目次

オンセンルームとは

当サイト「TRPGオンラインセッションSNS」を創設し、管理を行っている「ぽん太＠番頭」が開発した、ブラウザ上でTRPGのセッションを行うのに必要となる機能を一通り有したチャットアプリで、PC・スマホ共に利用できます。

・利用する場合は、当サイトでアカウント登録をすれば誰でもご利用いただけます。

・自設サーバーを設けたい方は以下の記事もご覧ください。

動作環境

オンセンルームの動作にはPHP7.x系※が必要となります。
※ 拡張モジュールに、xmlとcurlが必要です。

ダウンロード

最新バージョン

Ver.1.02.03までの旧バージョン

ダウンロードしたファイルは解凍してご利用ください。

設置方法

ディレクトリ・ファイル構成

解凍したファイルを以下のようにwebページのrootとなる箇所に設置してください。
(例)さくらレンタルサーバーなら/home/アカウント名/www/

root
　│　administer.php　…管理者用ページ
　│　index.php　…トップページ
　│　(以下ファイル省略)
　├cardset　…カードセット格納ディレクトリ
　│　(ファイルなし)
　├css　…css格納ディレクトリ
　│　(ファイル省略)
　├exe　…各種実行ファイル格納ディレクトリ
　│　(ファイル省略)
　├images　…画像格納ディレクトリ
　│　(ファイル省略)
　├js　…jsファイル格納ディレクトリ
　│　(ファイル省略)
　├log　…ログ格納ディレクトリ
　│　(ファイル省略)
　├r　…ルームデータ格納ディレクトリ
　│　│　(ファイル省略)
　│　└n
　│　　　　(ファイル省略)
　├s　…システム管理ディレクトリ
　│　│　(ファイル省略)
　│　├common　…基幹実行ファイル格納ディレクトリ
　│　│　　const.php　…定数ファイル
　│　│　　(以下ファイル省略)
　│　├db　…ダイスボット格納ディレクトリ
　│　│　　(ファイル省略)
　│　├list　…リストデータ管理ディレクトリ
　│　│　　(ファイル省略)
　│　└views　…システム管理ディレクトリ
　│　　　　(ファイル省略)
　└sounds　…楽曲格納ディレクトリ
　　　(ファイル省略)


(ディレクトリ名)　(ファイル名)

手順

  • PHP7.x系が使えるサーバーを準備する。
  • オンセンルームを準備する。
    • 上記ダウンロード項からファイルをダウンロードする。
    • ダウンロードしたファイルを解凍する。
    • 定数ファイル(const.php)を編集する。
      • SITE_TITLE を自分で決めたサイト名に書き換える。
      • ADMINISTRATOR_PASSWORD を自分で決めた管理者用パスワードに書き換える。
      • AUTHENTICATION_CODE を自分で決めたロビーサーバーとの認証用パスワードに書き換える。
    • 解凍した全てのファイルを自設サーバーにアップロードする。
    • root以下、サブディレクトリ・ファイルのパーミッションを755に変更する。←ここまでで使うことができます
  • TRPGオンラインセッションSNS(ロビーサーバー)と連動する。
    • ブラウザで自設サーバーに入れたオンセンルームの管理者ページ(administer.php)にアクセスする。
    • 自分で決めた管理者用パスワードを入力し、ログインする。
    • 「操作」の「申請オプション」を選んで決める。
    • 「操作」の「ロビーサーバーへ登録申請する」を押し、登録申請を完了させる。
  • オンセンルーム公式鯖と同じ画像・楽曲を使う。

補足解説

TRPGオンラインセッションSNS(ロビーサーバー)と連動

上記の連動を行うことで、TRPGオンラインセッションSNSからルームの作成やルーム一覧の閲覧などが行えるようになります。
また、DISCORDギルド（ボイスチャット）付きルームの作成を行う場合は、TRPGオンラインセッションSNSからのルーム作成が必要です。

注意
連動後、定数ファイル(const.php)の AUTHENTICATION_CODE の値を変更した場合、うまく連動しなくなりますので、 AUTHENTICATION_CODE を変更する場合、事前に連動を解除し、変更後、再度連動を行ってください。

オンセンルーム公式鯖と同じ画像・楽曲を使う。

オンセンルーム公式鯖で使われている背景画像・コマ画像、楽曲と同じものを自設サーバーで用意する場合の 手順などを別途解説ページで解説します。

別途解説ページはこちら

定数ファイル(const.php)を編集方法

SITE_TITLE の値を編集する場合

define('SITE_TITLE','オンセンルーム');
赤字の箇所に値を編集する。

編集例

define('SITE_TITLE','温泉ルーム＠たぬき鯖');
青字の箇所が編集した箇所。

コマの追加方法

オンセンルーム公式鯖と同じものを使用する場合は、こちらもご覧ください。

手順

  • imagesフォルダにコマ画像を追加する。
  • sフォルダ配下listフォルダ内のchessman_list.txtに追加した画像の情報を追記する。

chessman_list.txtの記述方法

下記のレコードをコマ情報として読み込みます。

レコード

画像パス,コマID,コマ種別,width,height,参照位置X,参照位置Y,コマ名称1,コマ名称2

値の説明

画像パス … 画像のパス、images/~から記述する。
コマID … マーキングはrangeNtB~、コマはchessmanNtB~と記述する。
コマ種別 … コマの種類に対する名称。戦士コマや魔法使いコマなどは「人間」など
width … 画像のサイズ width
height … 画像のサイズ height
参照位置X … コマ表示ウィンドウで参照する画像表示位置、基本は0。
参照位置Y … コマ表示ウィンドウで参照する画像表示位置、基本は0。
コマ名称1 … ボード配置時のコマ名称
コマ名称2 … コマ表示ウィンドウ上で表示されるコマ名称

記述例

images/human001.png,chessmanNtB001,人間,32,32,0,0,村人,村人

背景画像の追加方法

オンセンルーム公式鯖と同じものを使用する場合は、こちらもご覧ください。

手順

  • imagesフォルダに背景画像を追加する。
  • sフォルダ配下listフォルダ内のbackimage_list.txtに追加した画像の情報を追記する。

backimage_list.txtの記述方法

下記のレコードをコマ情報として読み込みます。

レコード

画像パス,背景名称

値の説明

画像パス … 画像のパス、images/~から記述する。
背景名称 … 背景の名称を記述する。

記述例

images/back/map_03.png,□ 草原1

BGMの追加方法

オンセンルーム公式鯖と同じものを使用する場合は、こちらもご覧ください。

手順

  • soundsフォルダにコマ画像を追加する。
  • sフォルダ配下listフォルダ内のmusic_list.txtに追加した画像の情報を追記する。

music_list.txtの記述方法

下記のレコードを楽曲情報として読み込みます。

レコード

楽曲URL,楽曲名

値の説明

楽曲URL … 画像のパス、images/~から記述する。
楽曲名 … 楽曲の名称を記述する。

記述例

http://sample.com/sounds/bgm001.mp3,サンプル曲001

使用できるダイスボット(BCDice)の設定方法

手順

  • sフォルダ配下listフォルダ内のbac_gamelist.phpに使用したいダイスボットの情報を追記する。

bac_gamelist.phpの記述方法

下記の配列をダイスボットの情報として読み込みます。

$bac_gamelist['BAC_KEY']=array('DICEBOT_NAME','DICEBOT_INSTRUCTION','DICEBOT_KEY');
赤字の箇所に値を入れる。値は下記を参照。

値の説明

BAC_KEY … BCDiceのダイスボットを呼び出す際のキー
記述ルール：追加するBCDiceのダイスボットの値（Cthulhuなど）の前にbac_をつける。
DICEBOT_NAME … ダイスボットの名称
DICEBOT_INSTRUCTION … ダイスボットの説明文。基本は空値
DICEBOT_KEY … オンセンルームのゲームごとの固有のキー。この値で紐づけを行う。
sフォルダ配下listフォルダ内のtrpg_sys_list.phpを参照（例：g2はクトゥルフ神話TRPG）

記述例

$bac_gamelist['bac_Cthulhu']=array('クトゥルフ','','g2');

Ｑ＆Ａ

Ｑ1.

CPU負荷が100%または常に高負荷でルームに入れません。

Ａ1.

CPU負荷はロードアベレージ÷コア数で判断しているため、コア数が実質コア数より少なく設定されているまたは常に処理待ちタスクがある状態だと 100%または常に高負荷な表示となります。初期値はコア数を4と設定されているため、 使用しているサーバーのコア数を確認し、定数ファイル(const.php)の CPU_CORE を変更してください。

また、CPU負荷による入場制限は定数ファイル(const.php)の ALLOWABLE_LOAD_LIMIT で設定されています。 初期値は90でこれを100にした場合は、CPU負荷による入場制限をなくすことができます。

Ｑ2.

ロビーサーバーの登録申請で「ロビーサーバーからのアクセスが失敗したため登録は中断されました」と出て失敗する。

Ａ2.

ロビーサーバーの登録申請を行うとロビーサーバーからルームサーバー(自設サーバー)へアクセスを行います。 これが失敗すると上記のエラーがでて登録が行われません。主な原因はルームサーバーのホスト・IPアクセス拒否設定あるいはexeディレクトリィ以下のパーミッションが低いための実行失敗となります。

ライセンスについて

使用許諾

「オンセンルーム」のライセンスはMITライセンスとします。
URL： https://trpgsession.click/onsenroom.php

ライブラリ及び一部画像のライセンスについて

当アプリケーションは、以下のライブラリ、画像を使用しています。
ライブラリ及び一部画像はそれぞれのライセンスに従ってご利用ください。

ライブラリ

JQuery ＝＞ JQuery

BCDiceAPI ＝＞ BCDiceAPI

画像

imagesディレクトリ配下dice*の画像　＝＞ ニコニ・コモンズ

履歴

CHANGELOG.md