Lispy bullet hell engine written in Guile and C
C Scheme C++ Objective-C
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
module
src
.gitignore
LICENSE
Makefile
README.md
TODO.org
demo.scm

README.md

Gnumaku

About

Gnumaku is (trying to be) a libre game engine for creating bullet hell shooting games in the Scheme language.

Screencast

Another screencast

Tech

Gnumaku is written in C and Scheme. GNU Guile is the Scheme implementation used, as it is the official GNU extension language and fairly easy to work with.

The Allegro 5 game library has been chosen for it's simplicity and use of OpenGL accelerated rendering rather than software rendering.

A good shootemup engine requires a way to make awesome bullet patterns easily. Gnumaku features a robust bullet system capable of processing thousands of bullets efficiently. Bullets have many customizable properties and can be manipulated after they are emitted for creating complex behavior.

Writing scripts using the built-in coroutines is an easy way to write a bullet pattern in a logical, linear fashion.

Here's what a simple bullet script might look like:

(define-coroutine (player-shot-1 player)
  (when (shooting player)
    (play-sample (shot-sound player) 1 0 1)
    (let ((pos (position player))
          (speed 15)
          (bullets (bullet-system player))
          (type 'sword))
      (emit-bullet bullets pos speed 269 type)
      (emit-bullet bullets pos speed 270 type)
      (emit-bullet bullets pos speed 271 type))
    (wait player 3)
    (player-shot-1 player)))

This script first checks if the player's shooting flag is currently set. If so, 3 bullets are fired and a sound sample is played. The bullets are emitted from the player's bullet system. The bullets have a speed of 15 pixels per second. They are fired from the player's current location with directions of 269, 270, and 271 degrees, respectively. 'sword refers to the type of bullet to fire. Bullet types define the image, hitbox, and blend mode that the bullet has. The procedure is then stopped and scheduled in the player's agenda to resume after 3 frames have passed. When the script continues, we recursively call the procedure and the process repeats until the player is no longer in the shooting state.

It should be noted that the Gnumaku engine isn't strictly for shootemup games. Gnumaku provides the building blocks to make many other types of games.

Additional Gnumaku features:

  • Tilesets
  • Sprites
  • Sound effects and music
  • 2D scene graph
  • Particle effects

Dependencies

GNU Guile >= 2.0 Allegro >= 5.0

Note: Guile 2.0 currently has issues compiling on Windows. Until that is resolved, Gnumaku cannot run on Windows.

Try the Demo!

make
make run-demo

License

GNU GPL v3

Thanks

Thanks to mark_weaver and ijp for helping me with everything Scheme and Guile related on a regular basis.

Thanks to wingo for his coroutine implementation.

Thanks to MIT Press for SICP.

Thanks to the fine folks on the #guile and #allegro rooms on freenode.