annotate README @ 51:cbb301016a4e

* oops... finishing what was started and not said with the other patch: fixing memory leaks
author thib
date Fri, 17 Apr 2009 18:40:39 +0000
parents 6581f7eccd26
children 15a18fbe6f21
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
1 OtakuNoRaifu
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
2 ------------
0
223b71206888 Initial import
thib
parents:
diff changeset
3
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
4 OtakuNoRaifu is a libre reimplementation of RealLive Visual Novel engine.
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
5 It is a fork of Jagarl's xclannad (which can be found at
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
6 http://www.creator.club.ne.jp/~jagarl/xclannad.html).
0
223b71206888 Initial import
thib
parents:
diff changeset
7
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
8 OtakuNoRaifu doesn't suffice to itself, it will need a game to run.
0
223b71206888 Initial import
thib
parents:
diff changeset
9
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
10 Project site: http://www.sitedethib.com/otakunoraifu/
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
11 SVN: http://www.sitedethib.com/svn/otakunoraifu/
0
223b71206888 Initial import
thib
parents:
diff changeset
12
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
13
0
223b71206888 Initial import
thib
parents:
diff changeset
14
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
15 Dependencies:
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
16 -------------
0
223b71206888 Initial import
thib
parents:
diff changeset
17
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
18 The following dependencies are required for OtakuNoRaifu:
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
19 * SDL, SDL_mixer and SDL_gfx
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
20 * Freetype
0
223b71206888 Initial import
thib
parents:
diff changeset
21
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
22 Other dependences:
49
6581f7eccd26 * Correct --disable-x11
thib
parents: 46
diff changeset
23 * libvorbis or libtremor/libvorbisidec (to use it, specify --with-tremor when calling ./configure).
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
24 If you don't need vorbis playback, you can add --disable-vorbis to the ./configure args.
49
6581f7eccd26 * Correct --disable-x11
thib
parents: 46
diff changeset
25 * X11 is used by default, but you can build OtakuNoRaifu without it.
6581f7eccd26 * Correct --disable-x11
thib
parents: 46
diff changeset
26 Just add --without-x11 to the ./configure arguments.
0
223b71206888 Initial import
thib
parents:
diff changeset
27
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
28
0
223b71206888 Initial import
thib
parents:
diff changeset
29
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
30 How to build:
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
31 -------------
0
223b71206888 Initial import
thib
parents:
diff changeset
32
46
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
33 Just type './configure' followed by 'make'.
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
34 If you want to build nwatowav (an utility to convert background musics to wav files), add '--enable-nwatowav' to the './configure' call.
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
35 Same with visarc (an utility to extract some data, such as the graphics files).
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
36
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
37 Type 'make install' to install OtakuNoRaifu.
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
38
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
39
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
40
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
41 Running OtakuNoRaifu:
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
42 ---------------------
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
43
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
44 To run OtakuNoRaifu, type 'otakunoraifu' followed by the wanted options.
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
45
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
46 Options:
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
47 -f fullscreen mode
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
48 -d double buffer mode
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
49 -t set font (typeface)
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
50 -r set root path of the game (default /mnt/KEY/CLANNAD)
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
51 -k set xor key, if needed
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
52 -v show version and exit
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
53 -h, -? show help and exit
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
54
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
55 In-game keys:
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
56 ESCAPE or right mouse button:
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
57 In-game menu
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
58
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
59 SHIFT (while holding):
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
60 Skip mode
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
61
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
62 ALT+ENTER, F11:
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
63 Toggle fullscreen
3aa3d244ad90 Brand new README!
thib
parents: 18
diff changeset
64