# hac-game-lib - v1.0.0 - Release notes

hac-game-lib version

# Introduction

Finally the long awaited first official release for the hac-game-lib! This version contains so many changes thanks to so many people, let's dig in.

First I would like to thank the following contributors for all the work they did during Hacktoberfest and after:

# Release details

Let's see what it looks like in more details.

# Statistics

Item Data
Files changed 72
Additions 6114
Deletions 1512
Commits 217

The full list is available on Github, but as you can see from these numbers a lot of work has been done.

# Breaking changes

No breaking changes, but a lot of improvements.

# Documentation

During Hacktoberfest, the project got a lot of new contributors (18 new contributors !) and lots of things moved faster than usual. The result is a 100% API documentation coverage.

More tutorials and applied documentation is going to come in the near future.

# Bugfixes

Here is a list of the bug fixes in that release:

  • Fix map loading in the hgl-editor : now it can work with more than 10 maps.
  • Fix the same type of issue in the first screen of the hgl-editor.
  • Fix back menu building in the hgl-editor.

# Improvements / New features

Here we have a lot to talk about!

# More versatile get_key() function

Utils.get_key() can now capture all keys from the keyboard. That includes the arrow keys!

# Say hello to path finding

This release includes a brand new actuator: the PathFinder advanced actuator.

That one can navigate between waypoints by automatically finding the shortest path. A short video of the a simple NPC finding his way into a maze is available on the Youtube channel.

# Welcome Animations

Another new addition to the library is the freshly introduced Animation class. That one allows for a different kind of item representation: instead of the static one, we can now have animated models. It works for both Movables and Immovables objects.

Here is a bit of code that demonstrate both PathFinder and Animation:

# Creating the patroller
patroller = NPC(model=Sprites.ALIEN, name='patroller')
# Creating a PathFinder actuator
patroller.actuator = PathFinder(game=g, actuated_object=patroller)
# Adding the NPC to the game engine
g.add_npc(1, patroller, 42, 28)
# Setting the first destination of the patroller (technically not required)
patroller.actuator.set_destination(43, 29)
# Adding various waypoints
patroller.actuator.add_waypoint(43, 29)
patroller.actuator.add_waypoint(43, 34)
patroller.actuator.add_waypoint(39, 34)
patroller.actuator.add_waypoint(39, 40)
patroller.actuator.add_waypoint(44, 40)
patroller.actuator.add_waypoint(44, 28)
# Adding an animation to that patroller
patroller.animation = Animation(
    animated_object=patroller, refresh_screen=redraw, display_time=0.5,
# Adding frames to the animation
# Start the animation

# Multiple map directories in hgl-editor

The map editor is now able to deal with multiple directories in which it can lad and save boards. That feature will be improved in the next release to store the configuration file in a unified version across operating systems.

# Automation, build system and sanity

Finally a lot of work has been put into the "invisible" part of the development: the test and build workflow.

First of all, the entire library now passes Flake8 tests. Most of the errors were formatting but not only. Then we set up automatic continuous integration through CircleCI and an entire new process for contributions and pull requests.

Last but not least, we switch the dependency management and build system from pip to pipenv.

# Conclusion

A lot has happened for the hac-game-lib and we are all super happy to bring you that feature loaded release!

This first official release is now available on PyPi and on Github of course.

As usual, to install that new version, we strongly recommend to do it in a virtual environment:

pip3 install virtualenv --user
virtualenv hgl
cd hgl
source bin/activate
pip3 install pipenv hac-game-lib 

# Share

If you like that content, feel free to share it on social platforms:

# Comments

If you have any question or feedback, feel free to communicate in the comments.

Last Updated: 5/17/2020, 7:53:16 PM