https://github.com/ivanperez-keera/spaceinvaders
A Haskell game written in Yampa
https://github.com/ivanperez-keera/spaceinvaders
frp functional-reactive-programming game haskell opengl yampa
Last synced: 2 months ago
JSON representation
A Haskell game written in Yampa
- Host: GitHub
- URL: https://github.com/ivanperez-keera/spaceinvaders
- Owner: ivanperez-keera
- License: bsd-3-clause
- Created: 2015-11-12T13:43:58.000Z (over 9 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-07T11:01:36.000Z (over 1 year ago)
- Last Synced: 2025-03-26T06:34:35.931Z (3 months ago)
- Topics: frp, functional-reactive-programming, game, haskell, opengl, yampa
- Language: Haskell
- Size: 2.88 MB
- Stars: 26
- Watchers: 4
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE
Awesome Lists containing this project
README
# SpaceInvaders
[](https://travis-ci.org/ivanperez-keera/SpaceInvaders)
[](https://hackage.haskell.org/package/SpaceInvaders)
This is a Haskell Space Invaders game implemented using the Functional
Reactive Programming library Yampa.
The game has been created for educational purposes, but tries to feature a
substantial amount of the complexity often found in real arcade games. For example,
differentiated subsystems for physics/collisions, input, rendering/multimedia, logic, etc.
## Installation
The game is available on [hackage](https://hackage.haskell.org/package/SpaceInvaders) and you can install it with*:
```
$ cabal update
$ cabal install SpaceInvaders
$ export PATH="$HOME/.cabal/bin:$PATH"
$ spaceInvaders
```
If you want to explore the code and possibly make changes, do the following:
```
$ cabal update
$ cabal unpack SpaceInvaders # or git clone https://github.com/ivanperez-keera/SpaceInvaders.git
$ cd SpaceInvaders* # Game resources are here
$ cabal install
$ export PATH="$HOME/.cabal/bin:$PATH"
$ spaceInvaders
```
*__Additional notes__:
For the use of the above installation instructions you need [GHC](https://www.haskell.org/ghc/) and the [command-line interface for cabal](https://github.com/haskell/cabal/tree/master/cabal-install). On debian/ubuntu, you can install them with:
```
$ sudo apt-get install ghc cabal-install
```
## Documentation
To try and make things as clear as possible, the code includes a much haddock
documentation and comments as we could reasonably fit. You can compile those with:
```
$ cabal unpack SpaceInvaders # or git clone https://github.com/ivanperez-keera/SpaceInvaders.git
$ cd SpaceInvaders* # Game resources are here
$ cabal haddock --haddock-executables
```
## Related slides and projects
* Paper: [The Yampa Arcade, by Antony Courtney, Henrik Nilsson, and John Peterson](http://www.cs.nott.ac.uk/~psznhn/papers.html#hw2003). Used to explain FRP to new audiences.
* Talks: [The Yampa Arcade, Haskell Symposium 2003](http://www.cs.nott.ac.uk/~psznhn/Talks/HW2003-YampaArcade.pdf).
* Talks: [FRP Games and Music, 2016](http://www.cs.nott.ac.uk/~psznhn/Talks/7digital-July2016-IntroductionToFRPAndYampaThroughGamesAndMusic.pdf) (also available as [handout](http://www.cs.nott.ac.uk/~psznhn/Talks/7digital-July2016-IntroductionToFRPAndYampaThroughGamesAndMusic-4up.pdf)). Makes some comparisons with Cycle.js and XStreams.
* Talks: [Lectures on FRP, 2010](http://www.cs.nott.ac.uk/~psznhn/ITU-FRP2010/ITU-FRP2010.html). Includes SpaceInvaders as an example.
* Projects: [Yampa](http://github.com/ivanperez-keera/Yampa), the Arrowized Functional Reactive Programming implementation created by Henrik Nilsson and Antony Courtney.
* Projects: [Haskanoid](https://github.com/ivanperez-keera/haskanoid), a game that uses SDL multimedia, wiimote and kinect. It's cross platform and works in desktop, mobile, and [web](http://ivanperez-keera.github.io/haskanoid/haskanoid.jsexe/index.html) (compiled with [GHCJS](https://github.com/ghcjs/ghcjs)).
* Projects: [Magic Cookies](https://github.com/keera-studios/magic-cookies), a commercial FRP game written in Haskell using Yampa available on [iTunes](https://itunes.apple.com/us/app/magic-cookies/id1244709871) and [Google Play for Android](https://play.google.com/store/apps/details?id=uk.co.keera.games.magiccookies&hl=en).
## Educators
If you find this game attractive and would like to use it to teach functional
programming or other subjects, we'd be very happy to know about it. We can
provide extra material that you can show to students (videos, screenshots,
etc.).
## Help and collaboration
You can collaborate at least in two ways:
* File an [issue](https://github.com/ivanperez-keera/SpaceInvaders/issues).
* Write documentation (send a link and/or a pull request).
We would like to call on Haskell programmers, game developers and anyone with an interest in Functional Reactive Programming and/or Game Programming to review the code, ask for clarification when it is not clear enough, and help us improve the game, and the state of FRP/Yampa programming as well.
## Author
* Henrik Nilsson
* Antony Courtney
### Maintainer
* Ivan Perez