# Hikou no mizu 0.9

## Description

Hikou no mizu is a libre software anime-inspired fighting game.
The characters fight using natural powers, e.g., water or lightning. 
All the graphics are free (various free software licences) and drawn with a vectorized style.

The dependencies of Hikou no mizu are:
- SDL2, SDL2_Image
- OpenGL (1.1 +)
- Freetype2
- OpenAL, libogg, libvorbis, libvorbisfile
- TinyXML
- libpthread

Additionally, to regenerate the data from data source files, the following
extra dependencies should be installed:
- synfig
- inkscape
- imagemagick
- xz

Many thanks to the contributors of all these libraries!


## License

See COPYING.


### Project website

https://hikounomizu.org


### E-mail address

duncan@hikounomizu.org


## Changelog

**Hikou no mizu 0.9**

- Audio & Sound
  - Added a flexible sound effect system
    - Sound effects are described for each animation
    - Variation of pitch to increase realism
  - Footstep sounds depend on the ground material
  - Added weapon hit, ground hit, and air friction sound effects
  - Added several musics for fight scenes
  - Added UI sounds for character & arena selection

- Graphics
  - Automated scaling of the framesets generated from source animations
  - Animations regenerated, scaled up for a 1080p gameplay
  - Smooth movement of the dynamic fight camera
  - Takino: Redrawn default punch animation
  - More flexible display mode option, especially windowed
  - UI elements scale to match the display mode

- Gameplay
  - Added a jump state, with its own attacks and hit animations
  - Added a versus mode, two players always facing each other
  - Added a specific camera zoom level per arena
  - Added a remaining throwable weapon interface counter
  - Physics of throwable weapons improved
  - Starting position of players improved

- UI & Options
  - Added sound volume control sliders
  - Moved key binders to a new tab
  - Removed 'apply' button in the options
  - Pressing escape resets the main menu
  - Text height computation fixed


## Installation

Hikou no mizu uses CMake as a building system.


### Data build

In order to function properly, Hikou no mizu needs to access its 'data/' folder.
Hikou no mizu is likely to come with a pre-built 'data/' folder in its root directory.
If not, or if you wish to rebuild the data from source, you may use the 'datasrc/' directory
as follows:

$ mkdir databuild
$ cd databuild
$ cmake ..
$ make data

Note: Before proceeding to the installation, do ensure that
the data/ folder was generated.


### Source code build & installation

To build and install the project, you may type,
from the same directory where this README is located:

$ mkdir build
$ cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=prefix/path/to/installation -DCMAKE_INSTALL_DATADIR=where/data/should/be/installed
$ make
$ make install

Example for a unix system-wide installation:
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr
$ make -j4
$ make install
$ hikounomizu   # Launch the game

Example for a standalone installation: (installation of the executable in the project
                                        directory, with a relative reference path to data)
$ cmake .. -DHNM_STANDALONE=1
$ make -j4
$ make install
$ cd ..
$ ./hikounomizu # Launch the game locally

Example for a debug build to run the game locally without installation:
                                    (will break if the data dir is moved)
$ cmake .. -DHNM_NOINSTALL=1
$ make -j4
$ ./hikounomizu # Launch the game locally
