yampa-sdl2: Yampa and SDL2 made easy

[ library, mit, scene ] [ Propose Tags ]

yampa-sdl2 lets you start coding your app right away instead of dealing with SDL2 first.


[Skip to Readme]
Versions [faq] 0.0.1.1, 0.0.2.0, 0.0.2.1, 0.0.3.0, 0.0.3.1, 0.1.0.0, 0.1.0.1, 0.1.0.2
Dependencies base (>=4.7 && <5), colour, linear, memoize, sdl2, StateVar, text, vector, Yampa [details]
License MIT
Copyright 2018 Simre
Author Simre
Maintainer simre4775@gmail.com
Category Scene
Home page https://github.com/Simre1/YampaSDL2#readme
Uploaded by simre at Thu Mar 8 22:20:23 UTC 2018
Distributions NixOS:0.1.0.2
Downloads 1521 total (74 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for yampa-sdl2-0.1.0.0

[back to package description]

YampaSDL2

YampaSDL2 is basically a headstart for the FRP library Yampa and SDL2. All the boilerplate which is normally necessary for these two libraries to work together is already taken care of. In the end, all that remains is a high-level interface specifically tailored to Yampa which should get you going in no time.

Screenshot

Screenshot of some drawn shapes.

My primary Goals:

  • As little setup as possible
  • Easy to use (some feedback would be appreciated)

Roadmap

  • [ ] Display Shapes
    • [x] Rectangle
    • [x] Circle
    • [x] Triangle
    • [ ] Polygon
  • [x] Display Images
  • [x] Animations
  • [x] Handle Input
  • [ ] Play sound

This library is still work in progress

Getting started

Prerequisites

yampa-sdl2 uses the C-libraries

  • sdl2
  • sdl2-gfx

Consequently, you need to have these two libraries installed on your computer.

Installation

yampa-sdl2 is now on hackage! Adding yampa-sdl2 to your dependencies and executing the following should do the trick.

stack update
stack solver --update-config
stack build

How to use

Head over to the wiki.

License

This project is licensed under the MIT License - see the LICENSE file for details.