diff README @ 46:3aa3d244ad90

Brand new README!
author thib
date Thu, 26 Mar 2009 18:06:32 +0000 (2009-03-26)
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
+------------
 
-���󥹥ȡ���
-	����ɬ�פʥ饤�֥����
-		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  �Υ��ץ����˻��ꤹ��
-		ɬ�פ�����ޤ�������ʳ��Υ饤�֥��ϼ�ưŪ�˸����������Ѥ��ޤ���
-
-	����./xlovesys.cc ��Ƭ����Ԥ��Խ������ե����̾�ȥ������
-	�������󥹥ȡ��뤵�줿�ǥ��쥯�ȥ�̾�����ꤷ�ޤ�
-	����./configure; make;
-	����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	�ʰץإ��ɽ��
-
-������
-	������ʥɡ��ץ�󥻥����֥饤�ɡ����������ή������Ƭ�Ȱ������ʥꥪ�Τ�ư���ǧ���Ƥ���ޤ���
-	�����奢�ե����ϥ������ư����Ȥ����ޤdz�ǧ���Ƥ���ޤ���
-	��¾�Υ����बư���ݾڤϤ���ޤ���
-
-���
-	������������Ū�� 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
+