taisei/README.md
Andrei "Akari" Alexeyev 52286cac7f Rewrote the key=value parser into something more sensible
Also updated the readme
2017-03-16 08:35:31 +02:00

2.4 KiB
Raw Blame History

Taisei

Introduction

Taisei is an open clone of the Tōhō Project series. Tōhō is a one-man project of shoot-em-up games set in an isolated world full of Japanese folklore.

Installation

Dependencies:

  • SDL2, SDL2_ttf, SDL2_mixer
  • libpng
  • zlib
  • OpenGL
  • CMake (build system)
  • pkg-config (build dependency)

To build and install Taisei just follow these steps.

mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=$yourprefix ..
make
make install

This will install game data to $prefix/share/taisei/ and build this path statically into the executable. This might be a package maintainers choice. Alternatively you may want to add -DRELATIVE=TRUE to get a relative structure like

$prefix/taisei
$prefix/data/
($prefix/config)

RELATIVE is always set when building for Windows.

NOTE ABOUT REPLAYS

As of version 1.0 replays are not guaranteed to work between different operating systems or architectures (or compiler versions). Screen capture your replays if you really want to publish them.

NOTE ABOUT BACKGROUND MUSIC

Currently Taisei does not include any background music. To use this feature, you should have required audio files in bgm/ subdirectory. BGM (as well as SFX) may be in .wav, .flac, or .ogg format; additionally you may try another formats such as .mp3, .aiff, .mod, .xm, etc. if your build of SDL2_mixer supports these formats.

Complete music pack consists of 16 bgm_*.(ogg/wav/flac) files, where * means:

    credits     BGM for credits screen
    ending      BGM for ending
    gameover    BGM for game over screen
    menu        BGM for menus (excluding in-game menu which pauses BGM)
    stageN      N=1..6, standard stage theme
    stageNboss  N=1..6, boss theme for a stage

If you want to specify stage/boss theme names to be shown during gameplay, you may do it by editing the bgm/bgm.conf file.

Sound problems

If your sound becomes glitchy, and you encounter lot of console messages like: ALSA lib pcm.c:7234:(snd_pcm_recover) underrun occurred, it seems like you possibly have broken ALSA configuration. This may be fixed by playing with parameter values of pcm.dmixer.slave option group in /etc/asound.conf or wherever you have your ALSA configuration. Commenting period_time, period_size, buffer_size, rate may give you the first approach to what to do.

Contact

http://taisei-project.org/

#taisei-project on Freenode