FIX: integer overflow on negative looping areas
[Tsunagari.git] / README.txt
blob057d857261f36aff1b06b751229158489ae2bf91
1 ________                                _________________    ________ 
2 \_____  \   _____   ____   _________   /   _____/\______ \  /  _____/ 
3  /   |   \ /     \_/ __ \ / ___\__  \  \_____  \  |    |  \/   \  ___ 
4 /    |    \  Y Y  \  ___// /_/  > __ \_/        \ |    `   \    \_\  \
5 \_______  /__|_|  /\___  >___  (____  /_______  //_______  /\______  /
6         \/      \/     \/_____/     \/        \/         \/        \/ 
7 <http://omegasdg.com/>
9 -----
11 Tsunagari Tile Engine
12 <http://tileengine.org/>
14 Alpha Preview Release 4 "Akatsuki" Revision 4
16 -----
18 Tsunagari is a tiling game engine inspired by the cult classic game Yume Nikki. It is intended as an open source alternative to the popular proprietary RPGMaker game development suite that the original and most fangames were/are written on. The initial focus is support for all of the features of Yume Nikki, and beyond that it strives to become a fully-featured 2D game development suite. Tsunagari is written in C++, using the Gosu framework.
20 Features:
21 Tsunagari will be a comprehensive game design suite for singleplayer 2D games. The engine will support several styles, such as roguelikes, and old console-style RPGs. Multiplayer support is planned for the second stable release. Tsunagari allows Python scripting for the event system, and for additional custom functionality. As a suite, Tsunagari aims to allow as much game variation as possible without direct modifications to the engine source code. Game design will require manual file editing during the Alpha and Beta phases, but a game editor suite will be shipped with the first major release.
23 Current features include:
24 * Yume Nikki-like and roguelike movement modes.
25 * Music and sound effects handling.
26 * Tile and sprite animations.
27 * Intelligent viewport tracking.
28 * Support for infinite graphical and walkable layers.
29 * Resource caching for nonexistent load times.
30 * Command line options for fine-tuning.
31 * Subpixel rendering.
32 * Looping areas support.
33 * NPCs.
34 * Event scripting interface in Python.
36 Tsunagari is released under the MIT/Expat license.
38 Requirements:
39 NAME        LICENSE     LINK
40 libboost    (BOOST)     http://www.boost.org/
41 libgosu     (MIT)       http://github.com/jamer/gosu/tree/quake2_allocblock (fork)
42 libpython   (PSF)       http://www.python.org/
43 libxml2     (MIT)       http://xmlsoft.org/
44 PhysicsFS   (ZLIB)      http://icculus.org/physfs/