hypatia_engine 0.2.27

2D action adventure game engine

Hypatia 0.2.27 (alpha)

Hypatia 0.2

Make 2D action adventure games. For programmers and nonprogrammers alike.

Create a games like *Legend of Zelda: Oracle of Ages* and *Oracle of Seasons*.

The included demo game (demo/game.py) in action:

The demo game in action.

Cross-platform (Windows, Mac, Linux, BSD), putting FreeBSD development first.

A labor of love, permissively (MIT) licensed, and crafted by Lillian Lemmer.

Please read about how you can help support Hypatia!

Resources

• Installation instructions.

• Hypatia Wiki (great resource for nonprogrammers, too!)

• Hypatia API Docs

• For people, checkout the socialization and contact methods for the Hypatia project.

• The official Hypatia website

• Official support chat: #hypatia on Freenode (webui!)

• You can contact the author via email: [e-mail], [@LilyLemmer](https:/twitter.com/LilyLemmer) on Twitter.

Dive in without any programming

The included demo allows you to mess with all of its resources (see the resources directory!). With it you can:

• Create tilesheets to make tilemaps

  • Configure tiles from the tilesheet

  • Chain tiles together to create animations

  • Apply the “cycle” effect, which takes a non-animated tile, and creates an animated tile by rotating the colors used in the tile

  • Set tile flags, like the impass_all flag which makes a flag impassable to the player

• Create tilemaps with an arbitrary number of layers, using plaintext files

• Create scenes, with configurable NPCs, configurable scene data (player start position)

• Create character sprites using animated or non-animated GIFs

For more information, please read the official wiki guide for non-programmers.

Quick Demo

Windows

Simply run game.exe after extracting hypatia-demo-windows-current.zip.

Other

To get setup quickly and start tinkering around with the demo, simply issue the following commands:

1. pip install hypatia_engine

2. cd demo

3. python game.py

File and Directory Notes

IMPORTANT

These files are IMPORTANT and you should read them before getting started with Hypatia (excluding this README.md):

• CHANGELOG.md

• LICENSE

• CONTRIBUTING.md

• CODE-OF-CONDUCT.md

Install Scripts

The following scripts are available for installing Hypatia on specific platfroms from the repo source in the form platform-major python version.sh:

• install-netbsd-python2.sh

• install-ubuntu-python2.sh

• install-linuxmint-python3.sh

• install-linuxmint-python2.sh

• install-freebsd-python2.sh

• install-base-python2.sh: this shouldn’t be directly ran.

distribute.sh

This script is used for distributing A NEW RELEASE to PyPi.

demo/

This directory hosts game.py, which is a demo of Hypatia. It also hosts the demo’s editable resources.

docs/

Sphinx docs source. Use the custom make-sphinx.sh to build the sphinx documentation from the docstrings.

The built Sphinx docs are published to the official Hypatia website, at the following URI: http://lillian-lemmer.github.io/hypatia/api

etc/

OPTIONAL configurations/configuration scripts, helper files, etc. Worth checking out! Has a objecttypes.xml for Tiled editor!

hypatia/

The actual Python package source.

media/

Media, namely pictures, officially related to Hypatia as a project, e.g., logos, icons.

requirements/

The requirements files installable by pip. Notes on the files:

Requirements File	You’d want to use if…
base.txt	ALWAYS!
python2.txt	You use Python 2.x!
testing.txt	You want to test and/or contribute to the code!
travis.txt	NEVER

tests/

Unit tests for py.test and Travis Continuous Integration. These files are for assuring Hypatia’s API remains consistent, reproducible, functional, etc. They are in part what determines build success/fail according to Travis CI. See our build badge.

See also: test.sh, it’s the official script to run when testing any changes.