Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A small game development framework for teaching programming to young kids.

Project description

Tested OS: Linux Untested OS: Windows, Mac OS GPLv3 license PRs Welcome Documentation Status CII Best Practices CircleCI

hac-game-lib

Hyrule Astronomy Club - base library for a game development

Introduction

This library is used as a base to teach coding to kids from 6 to 12. It aims at giving an environment to new and learning developers (including kids) that let them focus on the algorithm instead of the lousy display or precise management.

This is obviously extremely simple and does not aim at being anything serious for game developers (although it can probably be used as a nice base now).

There is a Youtube channel that contains tutorials.

base_game.py screenshot

Here is a quick view of what can currently be achieved with that library:

base_game.py animation

The base game makes use of:

  • The main "game engine" (gamelib.Game.Game)
  • Many different types of structures (from gamelib.Structures): Wall (well the walls...), Treasure (gems and money bag), GenericStructure (trees) and GenericActionnableStructure (hearts and portals)
  • Game()'s menu capabilities.
  • Player and NPC (from gamelib.Characters)
  • Inventory (from gamelib.Inventory)
  • Player and Inventory stats
  • RandomActuator (NPCs in level 2) and PathActuator (NPCs in level 1) (from gamelib.Actuators.SimpleActuators)

Requirements

Python

The hac-game-lib only supports Python 3+. It will not run with Python 2. We use pipenv to manage dependencies.

Run Pipenv to install the requirements (only colorama):

pip3 install pipenv
pipenv install

If you want the developmnent dependencies you need to run:

pip3 install pipenv
pipenv install --dev

Runing tests

To run the unit tests use the following command:

python -m unittest discover -s tests

Terminal color and emojis

It is not really a hard requirement but colored emojis are really bringing the games created to life.
We then recommend to have a color emojis font installed like Noto Color Emojis (on most Linux distributions you can install it from the package manager, search for "noto-color-emoji").

If your terminal application is not displaying color emojis, please have a look at this file and follow the instructions.

Running examples

To run the examples using pipenv:

pipenv shell
(hac-game-lib) cd examples
(hac-game-lib) python3 01_board_and_wall.py

Limitations

There is tons of limitations but for the most important ones:

  • Only one player is supported.
  • There is little protections against messing up with the internal. This is on purpose, I want the kids to learn to use the API not mess up with the internals of every single class.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hac-game-lib, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size hac_game_lib-1.0.1-py3-none-any.whl (67.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size hac-game-lib-1.0.1.tar.gz (50.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page