SOLD OUT MANUAL 2002-07-28

SOLD OUT MANUAL 2002-07-28

総合目次 > 設置方法やライセンスについて


はじめに

この説明書は、 WEB ブラウザを利用したネットワークゲーム「 SOLD OUT 」 CGI スクリプトの取り扱いに関する説明書です。

SOLD OUT の設置/運営にはある程度の知識を前提としています。 CGI スクリプト等の設置/運営経験が無い方は、まずは別の易しいスクリプト等で経験を積まれることをお勧めします。

なお、本説明書に表記の各種ディレクトリ名はデフォルトのモノを使用しています。 ディレクトリ名を変更した場合は各自置き換えてください。

謝辞

おかげさまで SOLD OUT の知名度も私の想像以上に上がり、大変嬉しく思っています。 設置してくださっているサイトさんの数も把握できない(申し訳ありません)くらいになっています。 本当にありがとうございます。 これからも SOLD OUT / MUTOYS をよろしくお願いします。

jcode.plについて

本スクリプトで利用させていただいた jcode.pl は Kazumasa Utashiro さんの著作物です。 同梱させていただきました。この場を借りて御礼申し上げます。

SOLD OUT利用ライセンス

配布スクリプト一式のライセンスは全て(jcode.plは除く) GPL に準じるものとします。 詳細は同梱の gpl.txt(英語)gpl.text(日本語) をご覧下さい。

サポート

基本的に行えません。 疑問点等ありましたら、配布説明書や MUTOYS(ムートイズ) http://mutoys.com/ (公式 WEB サイト) をご覧下さい。

設置環境条件

SOLD OUT は Perl5 で記述された CGI スクリプトです。 Perl5 が動作するサーバへ設置してください。

特殊なコマンドは使っていませんので多くの環境(サーバ)で動作すると思われます。 動作確認は FreeBSD or Linux + Perl5 + Apache で行いました。

Windows や Macintosh で動作するかどうかは分かりません。 少なくとも、 Windows 上では移転や貿易機能が使えないケースが報告されています。

前バージョンからの移行

ver.2001-11-11 以降からのバージョンアップは可能です。 全てのファイルを上書きし、soldout/_config.cgi もしくは soldout/_config-local.cgi を再設定してください。

note:今後もバージョンアップするつもりなら、 デフォルトからの変更設定を soldout/_config-local.cgi に記述することをお勧めします。 この方法だと、バージョンアップ作業はファイルの上書きのみで完了します。

ver.2001-11-11 より前のバージョンからのバージョンアップは残念ながら出来ません。新規設置して下さい。 一応、ゲームデータにはある程度互換性がありますので、腕に自身がある方は自己責任で挑戦してください。 が、ゲームバランス等の問題もありますので、お勧めはできません。

サーバ負荷

SOLD OUT は、出来る限りサーバへの負荷が少なくなるよう設計したつもりです。 しかし、(一概に比較は出来ませんが)重めの掲示板クラスの負荷があると認識しています。

サーバへの負荷は「アクセス数 > 最大店舗数 > 商品種類数 > 更新間隔」で決まると思いますので、 その辺りを念頭に置いて設置・カスタマイズをお願いします。特に共用サーバへ設置する方は気を付けてください。

特に、デフォルトの設定を大幅に超えた最大店舗数の設定や、 商品の増やしすぎ(詳細は カスタマイズ目次 をご覧下さい)は極力避けてください。

以下は負荷軽減のための設定方法です。

スクリプト設置方法

ファイル数は多いですが、設置ルールは単純です。

手順1 soldout/_config.cgi をテキストエディタ等で編集/設定する

最低でも管理者パスワード管理者メールアドレスを設定しないと動作しません。

手順2 soldout/admin.cgi の先頭行を環境に応じて書き換える

デフォルトでは #!/usr/local/bin/perl になっていますので、 環境に応じて書き換えてください。書き換える必要がない環境の場合は、手順3へ進んでください。

なお、本来であれば soldout/admin.cgi 以外のファイルも書き換える必要がありますが、 ここで全てのファイルを変更する必要はありません。 後ほど一括で自動書き換えを行いますので、まずは soldout/admin.cgi のみ書き換えてください。

手順3 ファイル/ディレクトリをサーバへアップロードする

以下の構成/パーミッションでアップロードしてください。 FTP ソフトにもよりますが、 soldout ディレクトリ を丸ごとそのままアップロードするだけで済むと思います。 パーミッションは下記の通りに変更してください。

スクリプト等のテキストファイルはアスキーモードで、 画像等のバイナリファイルはバイナリモードでアップロードしてください。

soldout <dir> [755] SOLD OUT ルートディレクトリ ├ _*.cgi [644] _で始まるcgiファイル全て ├ *.cgi [755] _以外で始まるcgiファイル全て ├ index.html [644] index.html ├ auto <dir> [755] 関数ディレクトリ ├ custom <dir> [755] カスタマイズディレクトリ ├ data <dir> [777] ゲームデータディレクトリ ├ guild <dir> [755] ギルドデータディレクトリ ├ image <dir> [755] 画像ディレクトリ ├ inc <dir> [755] カスタマイズ可能ファイルディレクトリ └ town <dir> [755] 移転用街データディレクトリ

[???] はパーミッション設定です。 各ディレクトリの中のファイルは全て [644] で設置して下さい。 SOLD OUT ルートディレクトリのファイルのみ、指定通りにしてください。

また、手順2soldout/admin.cgi を書き換えた場合は、 [755] に設定すべきファイルを全て [777] に設定してください。

note:注意:サーバによっては[755]を[705][700]、[644]を[604][600]という風に指定がある場合がありますので、 その場合はサーバの設定に従ってください。

手順4 ブラウザより http://....../soldout/admin.cgi にアクセスする

ブラウザより管理メニューへアクセスします。 ここでアクセスに失敗するようでしたら、手順1から再度やり直してください。 ほとんどの場合、どこかでミスをしています。

アクセスに成功したら、管理者パスワードを入力し、管理メニューへログインしてください。

ここで、手順2の時に書き換える必要があった方は、 「特殊な初期設定」の「スクリプト自動セッティング」を実行してください。 自動的に、必要なスクリプトの先頭行を書き換えます。 そして、この処理が終わった後はパーミッションを手順3の通りに設定し直してください

あとは画面上部の指示に従って初期設定を行います。 まずは「初期化」、続いて「商品データ生成」となると思います。

なお、この管理メニューは運営に便利な機能が多く搭載されています。運営に役立ててください。

手順5 ブラウザより http://....../soldout/index.cgi にアクセスする

最後に設置がうまく行ったかどうか確認します。 これで問題がなければ設置は完了です。お疲れさまでした。

ゲームアクセス URL

http://....../soldout/index.cgi

です。携帯端末(i モードなど)にも対応しています。

ユーザ名/パスワードを含んだ URL は

http://....../soldout/index.cgi?u=ユーザ名!パスワード

となります。当然、セキュリティ上大変危険ですので、それを踏まえてご利用下さい。 クッキーが利用できない携帯端末系では重宝するでしょう。

メンテナンスモード

各種メンテナンスは管理メニューで行えますが、行えない作業は手動で行ってください。

その際、soldout/lock というファイルかディレクトリを作成すると、 ゲームが一時停止状態になります。 これをメンテナンスモードと呼びます。

この状態でしたらデータファイルの入れ替えがやりやすいと思います。 ただし、スクリプトへのアクセスを禁止するものではなく、 あくまでも soldout/data ディレクトリの内容が変化しない状態というだけです。

スクリプトやデータファイルを操作する場合は、必ずメンテナンスモードにしてください。 そうしないと、最悪の場合、スクリプトやデータが壊れます。

soldout/lock ディレクトリ or ファイルが存在する状態では、「メンテナンス中です」という意味のメッセージが表示されます。 メンテナンスが終わったら soldout/lock ディレクトリ or ファイルを削除してください。

なお、これは管理メニューのメンテナンスモードと同一ですが、 手動でメンテナンスモードにした場合は手動で解除する必要があります。

soldout/data ディレクトリ内のファイル所有者

soldout/data ディレクトリにはゲームスクリプトによって自動的に各種データファイルが作成されます。 そのため、それらのファイルの所有者はいわゆる WEB ユーザになると思われます。 (サーバによっては設置ユーザかもしれません。)

そのため、 FTP ソフト等では削除できない場合があります。 その時は、管理者用ページでアンインストールを行って削除してください。

バックアップの取り方

通常、soldout/data/backup* というディレクトリが自動的に作成され、 そこへバックアップデータが格納されます。 そして、万が一ゲームデータが破損した場合は、 管理メニューよりバックアップから復元(復活)が出来ます。

それ以外に、別途バックアップを取る場合は、soldout/data ディレクトリのファイルを全てコピーしてください。

また、必要であれば「soldout/_config*.cgi、および、soldout/guildsoldout/townsoldout/custom ディレクトリのファイル」もどうぞ。 こちらはそれぞれ「設定ファイル、ギルド設定ファイル、街設定ファイル、カスタマイズデータ」になります。 通常、既に手元にマスターファイルがあるはずなので、別途バックアップの必要はないと思いますが。

それ以外のファイルは配布ファイルと同じものですので、バックアップの必要はありません。

手動バックアップからの復元方法

その前に、管理メニューには自動バックアップと復元方法を用意していますので、 問題がなければそちらを利用してください。

何かしら問題があり、手動でバックアップを復元する必要がある場合は、 まず管理メニューより「全データ削除(アンインストール)」を行い、 次に手動バックアップした soldout/data ディレクトリのファイルを全て FTP ソフト等でアップロードします。

その際、全てのファイル/ディレクトリのパーミッションを [777] に設定してください。 パーミッションを[777]相当にしないと上手く復元できない可能性があります。

あとは通常通りです。


総合目次 > 設置方法やライセンスについて