diff README @ 46:3aa3d244ad90

Brand new README!
author thib
date Thu, 26 Mar 2009 18:06:32 +0000
parents 4d7486cb20a9
children 6581f7eccd26
line wrap: on
line diff
--- a/README
+++ b/README
@@ -1,156 +1,62 @@
-+-------------------------------------------------------------------+
-|                                                                   |
-|        xclannad (RealLive for X) version. 0.07h                   |
-|                                                                   |
-|               Copyright (C) 2004-2008  Kazunori Ueno(JAGARL)      |
-|                                      <jagarl@creator.club.ne.jp>  |
-|                                                                   |
-+-------------------------------------------------------------------+
+OtakuNoRaifu
+------------
 
-インストール
-	0,必要なライブラリ等
-		SDL と SDL_mixer : 画面描画と音楽再生に使います。必須です。
-		FreeType2 : TrueType font を使用する場合、必要です。
-		smpeg : オープニング等の MPEG 動画の再生、MP3 再生に使用します。
-		mad : BGM ファイルが MP3 形式の場合、SMPEG の代わりに使用することができます。
-		ogg / vorbis / vorbisfile : BGM ファイルが OGG 形式の場合、必要です。
-		tremor (vorbisidec) : BGM ファイルが OGG 形式の場合、vorbisfile の代わりに使用することができます。
+OtakuNoRaifu is a libre reimplementation of RealLive Visual Novel engine.
+It is a fork of Jagarl's xclannad (which can be found at
+http://www.creator.club.ne.jp/~jagarl/xclannad.html).
 
-		tremor を使用する場合、 --enable-tremor を configure  のオプションに指定する
-		必要があります。それ以外のライブラリは自動的に検索し、使用します。
-
-	1,./xlovesys.cc 冒頭の二行を編集し、フォント名とゲームの
-	  インストールされたディレクトリ名を設定します
-	2,./configure; make;
-	3,make install すると xclannad と nwatowav (BGM再生に必要)が
-	    /usr/local/bin にインストールされます。 xclannad を実行すると
-	    ゲームが開始します
+OtakuNoRaifu doesn't suffice to itself, it will need a game to run.
 
-操作方法
-	・マウスの右クリック、またはキーボードの ESC キーでメニューが出ます。
-	・SHIFT キーを押しっぱなしにすると、早送りモードになります。
-	・ホイールの上下(マウスのボタン4,5)でバックログが見れます。
-	・セーブデータは ~/.xkanon/ に作成されます。
+Project site: http://www.sitedethib.com/otakunoraifu/
+SVN: http://www.sitedethib.com/svn/otakunoraifu/
 
-	・よく落ちます。
-	・ALT+リターン、または F11 で全画面モードに入れるはずですが、SDL の機嫌がよくないと
-	 ダメなようです。
+
 
-	・キーボードの"L"キーでロード画面が、"S"キーでセーブ画面が出てきます。
+Dependencies:
+-------------
 
-オプション
-	-f	フルスクリーンモードで起動
-	-d	SDL をダブル・バッファモードで起動
-	-t <font name>	フォント名指定 (既定値:msgothic.ttc)
-			( TrueType フォントのファイル名、もしくは X のフォント名を指定する)
-	-r <path>  ゲームのインストールされたディレクトリ(既定値:/mnt/KEY/CLANNAD)
-	-v	バージョン表示して終了
-	-h	簡易ヘルプ表示
-
-注意点
-	・クラナド、プリンセス・ブライド、彼女たちの流儀の冒頭と一部シナリオのみ動作確認してあります。
-	・智代アフターはゲームを起動するところまで確認してあります。
-	・他のゲームが動く保証はありません。
-
-著作権
-	ソースは全体的に jagarl が書いたものです
+The following dependencies are required for OtakuNoRaifu:
+    * SDL, SDL_mixer and SDL_gfx
+    * Freetype
 
-	font/ 以下の FreeType とのインターフェースは澤田さん(Samyさん)が作成して
-	下さった xkanon へのパッチに由来します
-	window/SDL_rotozoom.cc は A. Schifflerさん製作の SDL_gfx 2.0.9 内のコードを
-	ほぼそのまま使用しています。
-
-謝辞
-	上記、各パッチ等を作製くださった皆様、xkanon の開発にあたりお世話になった皆様、
-	ありがとうございます。xclannad は xkanon の延長線上にあるものです。
+Other dependences:
+    * libvorbis or libtremor/libvorbisidec (to use it, specify --enable-tremor when calling ./configure).
+      If you don't need vorbis playback, you can add --disable-vorbis to the ./configure args.
 
-	CAT さん(http://www.baywell.ne.jp/users/cat/)には、初期の RealLive の解析情報、
-	コマンドリストをいただきました。ありがとうございます。
+
 
-再配布等
-	・xkanonの一部を引きずっているのでソフトウェア全体のライセンスは GPL です。
-	・ソースは大部分BSD Licence です。BSD Licence のソースについては再利用はご自由に。
-
-	このプログラムの配布元は現在、
-		http://www.creator.club.ne.jp/~jagarl/xclannad.html
-	です。
+How to build:
+-------------
 
-履歴
-	2008/9/1	0.07hb
-		Thibaut GIRKA さんの英語版 CLANNAD 用パッチをmerge
-		CLANNAD / KANOGI で動かなくなっているところがあったので修正
-	2008/1/6	0.07h
-		し〜くるさんの Zaurus 版のパッチを merge
-		libmad / tremor (libvorbisidec) に対応する
-	2007/8/26	0.07g
-		リトルバスターズ!:戦闘画面の動作を修正(不安定版)
-	2007/8/18	0.07f
-		リトルバスターズ!:戦闘画面をひととおり処理できるようになる
-	2007/7/30	0.07e
-		リトルバスターズ!:スクリプト処理のうち script error が出る部分を修正し、
-		音楽ファイルのデコード処理に対応。nwatowav でリトルバスターズ!の
-		音楽もデコードできるようにする
-	2007/7/26	0.07d
-		彼女たちの流儀:ED、おまけモードに対応
-	2006/12/3	0.07c
-		彼女たちの流儀:テキストウィンドウ位置が「画面下側」設定に対応
-		彼女たちの流儀:名前ウィンドウが顔グラウィンドウの下に来るのを回避
-		彼女たちの流儀:バックログで顔表示がされるようにする
-		Back Screen Object (次の画面切り替え後のobject設定)用に従来 FORE_GRPフラグで
-		対応していたのを変更、GrpImpl::grpobj[] 以外に back screen object 情報管理
-		専用の GrpImpl::bs_obj[] を新設
-		選択肢巻き戻し、オートモードを追加
-		ウィンドウ管理系のバグ修正(画面切り替え時に画像チップの一部が切れるバグ)
-	2006/9/10	0.07b
-		智代アフター用:テキストウィンドウ、ボタン等を実装
-		智代アフター用:.nwk 形式の音声に対応
-		Shake の画像効果(CLANNAD; クマ攻撃時)
-		オブジェクトへのテキスト色を実装
-	2006/8/25	0.07a
-		healethさんの掲示板で指摘されたバグを修正(ボタンのON/OFFが変になっていた)
-		movie 終了時の処理を改善
-	2006/8/19	0.07
-		SDL_mixer 版を公開
-		healeth さんによるパッチを取り込む
-			http://dev.haeleth.net/xclannad.shtml
-			- クラナドのリターンパッチ除去
-			- 既読フラグ (RealLive ver. 1.2.5 以降)
-			- 演算子の優先順位
-			- 変数読み書きと文字列操作
-		MacOSX 用に big endian でもある程度動くように修正 (thanx to 黒川さん)
-		智代アフターを見た目は動くようにする(メニュー用はほとんど動かない)
-	2005/06/04	0.06
-		簡易バックログ実装
-	2005/05/01	0.05f(未公開)
-		Shish さんによるパッチ適用
-		起動用オプションをいくつか追加
-	2005/04/03	0.05e
-		バグフィクス版公開
-		ムービー再生に暫定対応
-		「パルフェ」のアーカイブ形式に対応
-		ogg-vorbis 形式の音声・効果音に対応
-	2005/03/07	0.05d
-		バグフィクス版公開
-		CG回想用に見たCGを保存するようにする (回想モードは未実装)
-	2005/02/26	0.05c
-		バグフィクス版公開
-	2005/02/26	0.05b
-		バグフィクス版公開
-	2005/02/20	0.05a
-		バグフィクス版公開
-	2005/01/20	0.05
-		スキップモード、「タイトルに戻る」など実装
-	2005/01/15	0.04
-		ロード・セーブメニューの作成(独自仕様)
-		CLANNADのロード・セーブ画面が動くようにする
-	2004/11/23	0.03
-		画像オブジェクト関連の命令を追加
-		CLANNAD のメニューが動くようになる(見かけのみ)
-		テキストウィンドウ背景の描画モード修正
-		半角文字が英字として表示されるようにする
-	2004/9/16	0.02
-		CLANNADが動いたので 0.02 公開
-	2004/9/3	0.01
-		READMEを書いて 0.01 公開
-	2004/8/31	xxxx
-		とりあえず完成
+Just type './configure' followed by 'make'.
+If you want to build nwatowav (an utility to convert background musics to wav files), add '--enable-nwatowav' to the './configure' call.
+Same with visarc (an utility to extract some data, such as the graphics files).
+
+Type 'make install' to install OtakuNoRaifu.
+
+
+
+Running OtakuNoRaifu:
+---------------------
+
+To run OtakuNoRaifu, type 'otakunoraifu' followed by the wanted options.
+
+Options:
+    -f          fullscreen mode
+    -d          double buffer mode
+    -t          set font (typeface)
+    -r          set root path of the game (default /mnt/KEY/CLANNAD)
+    -k          set xor key, if needed
+    -v          show version and exit
+    -h, -?      show help and exit
+
+In-game keys:
+    ESCAPE or right mouse button:
+        In-game menu
+
+    SHIFT (while holding):
+        Skip mode
+
+    ALT+ENTER, F11:
+        Toggle fullscreen
+