menu

pygamelib - documentation

Forewords

Historically, this library was (and still is) used as a base to teach coding to kids from 6 to 15. 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.

It started as a very simple library with very little capabilities, but over time it became something more. To the point that it is now possible to make very decent terminal games with it.

So this is obviously still extremely simple compared to other game framework and it still does not have the pretention of being anything serious for real game developers. However, it can now be used by aspiring game developers for an introduction to 2D games development.

Introduction

First of all, his module is exclusively compatible with python 3.6+.

The core concept is that writting a game mostly involve the Game object, the Board object and the derivatives of board_items.

More advanced game will use the ui module to create terminal user interfaces (or TUI) and the GFX core module to improve the graphics with Sprite and Color.

Here is an example of what the current version allow to build:

https://raw.githubusercontent.com/arnauddupuis/pygamelib/master/images/suparex-720.gif
The suparex game makes use of:
  • The main game engine (pygamelib.engine.Game)

  • Procedurally generated boards (pygamelib.engine.Board).

  • Many different types of structures (from pygamelib.board_items), like:

    • Wall (well the walls…),
    • GenericActionnableStructure (hearts and portals).
  • Game()’s menu capabilities.

  • Projectiles (the tree shooter, bolts and bombs)

  • Player and NPC (from pygamelib.board_items)

  • Player stats

Tutorials

Most tutorials to teach you how to use the library to build games are (or will be) on the wiki.

Tutorials that teach you how to expand the library are (or will be) centralized here.

The complete API documentation is referenced bellow.

Indices and tables