aphexus/yampa

Functional Reactive Programming domain-specific language embedded in Haskell, for programming hybrid (mixed discrete-time and continuous-time) systems.

Yampa

Domain-specific language embedded in Haskell for programming hybrid (mixed discrete-time and continuous-time) systems. Yampa is based on the concepts of Functional Reactive Programming (FRP) and is structured using arrow combinators.

Installation

Yampa is available on hackage: http://hackage.haskell.org/package/Yampa.

$ cabal sandbox init         # Optional, but recommended
$ cabal update
$ cabal install Yampa

Examples

There is a directory with examples, which includes two basic SDL examples and one with using a Nintendo Wii Remote. You can install them with:

$ cabal sandbox init         # Optional, but recommended
$ cabal update
$ cabal install Yampa -fexamples

Other examples

There are many programs written in Yampa. See the following examples:

• Haskanoid: a game that uses SDL multimedia, wiimote and kinect. It's cross platform and works in desktop, mobile, and web (compiled with GHCJS).
• Space invaders.
• Frag: a 3D first person shooting game.
• Yampa-2048: an implementation of the game 2048 using Yampa and Gloss.
• MandelbrotYampa: a "hello world" using SDL2, Yampa and OpenGL.
• Haskelloids: a reproduction of the Atari 1979 classic "Asteroids"

A more comprehensive list can be obtained using the reverse dependency finder (http://packdeps.haskellers.com/reverse/Yampa), but only programs uploaded to hackage are listed.

Haskanoid, SDL cross-platform arkanoid.	SpaceInvaders, GLUT arcade game	Yampa2048, a gloss board game

Use in production

• Keera Studios is using it for several Haskell games for Android and iOS including a game currently available on iTunes and Google Play. See:
  • http://facebook.com/keerastudios
  • https://itunes.apple.com/us/app/magic-cookies/id1244709871
  • https://play.google.com/store/apps/details?id=uk.co.keera.games.magiccookies

Backends

Yampa is backend agnostic, you can ultimately connect it to any backend you want. Existing backends include:

• SDL
• SDL2
• OpenGL / GLUT
• WX (see wxHaskell)
• HTML Canvas

Documentation and tutorials

The distribution of Yampa comes with substantial haddock documentation, which you can build using haddock or just read online. To build a local copy, do:

$ cabal unpack Yampa ## Or git clone this-repo
$ cd Yampa-*
$ cabal init
$ cabal install --only-dependencies
$ cabal configure && cabal haddock --internal

Documentation is also available online: https://wiki.haskell.org/Yampa

Papers and technical reports

• Extensible and Robust Functional Reactive Programming (Ivan Perez; 2017)

• Testing and Debugging Functional Reactive Programming (Ivan Perez and Henrik Nilsson; 2017)

• Functional Reactive Programming, Refactored (Ivan Perez, Manuel Bärenz, and Henrik Nilsson; 2016)

• Safe Functional Reactive Programming through Dependent Types (Neil Sculthorpe and Henrik Nilsson; 2009)

• Push-Pull Functional Reactive Programming (Conal Elliott; 2009)

• Switched-on Yampa: Declarative Programming of Modular Synthesizers (George Giorgidze and Henrik Nilsson; 2008)

• Demo-outline: Switched-on Yampa: Programming Modular Synthesizers in Haskell (George Giorgidze and Henrik Nilsson; 2007)

• Dynamic Optimization for Functional Reactive Programming using Generalized Algebraic Data Types (Henrik Nilsson; 2005)

• The Yampa Arcade (Antony Courtney, Henrik Nilsson, and John Peterson; 2003)

• Arrows, Robots, and Functional Reactive Programming (Paul Hudak, Antony Courtney, Henrik Nilsson, and John Peterson; 2002)

• Functional Reactive Programming, Continued (Henrik Nilsson, Antony Courtney, and John Peterson; 2002)

• Genuinely Functional User Interfaces (Antony Courtney and Conal Elliott; 2001)

• See also:

  • Henrik Nilsson's publications
  • Ivan Perez's publications
  • First Year PhD Report (Ivan Perez, 2014), chapter 3 includes a review of FRP and outlines some existing issues.

Help and collaboration

You can collaborate at least in three ways:

• File an issue (https://github.com/ivanperez-keera/Yampa/issues).

• Write documentation (send a link and/or a pull request).

• Research: we are constantly trying to improve Yampa. We'd be glad to have collaborators. If you are working on this, please, let us know.

  (Interactivity and FRP is the main topic of my (ongoing) work and research, so I'll keep working on this for some time. -- Ivan Perez)

Authors

• Henrik Nilsson
• Antony Courtney

Maintainer

• Ivan Perez