root/README

OtakuNoRaifu
------------

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).

OtakuNoRaifu doesn't suffice to itself, it will need a game to run.

Project site: http://www.sitedethib.com/otakunoraifu/
SVN: http://www.sitedethib.com/svn/otakunoraifu/



Dependencies:
-------------

The following dependencies are required for OtakuNoRaifu:
    * SDL, SDL_mixer and SDL_gfx
    * Freetype

Other dependences:
    * libvorbis or libtremor/libvorbisidec (to use it, specify --with-tremor when calling ./configure).
      If you don't need vorbis playback, you can add --disable-vorbis to the ./configure args.
    * X11 is used by default, but you can build OtakuNoRaifu without it.
      Just add --without-x11 to the ./configure arguments.



How to build:
-------------

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) and scn2kdump (an utility to dump all data from a scenario file).

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



Known bugs:
-----------

* The stack state is inconsistent in some saves. So, DO NOT SAVE RIGHT
  AFTER A SCENE IN THE ILUSIONARY WORLD. Just read one more dialog before
  saving.

* You cannot change your name yet (the text input boxes are not implemented yet)