diff --git a/FunGEn.cabal b/FunGEn.cabal --- a/FunGEn.cabal +++ b/FunGEn.cabal @@ -1,5 +1,5 @@ name: FunGEn -version: 0.4.5 +version: 0.4.6 copyright: (C) 2002 Andre Furtado license: BSD3 license-file: LICENSE @@ -7,8 +7,29 @@ maintainer: Simon Michael homepage: http://joyful.com/fungen category: Game -synopsis: FUNctional Game ENgine -description: A lightweight, cross-platform, OpenGL/GLUT-based game engine +synopsis: A lightweight, cross-platform, OpenGL/GLUT-based game engine. +description: + FunGEn (Functional Game Engine) is a BSD-licensed, cross-platform, + OpenGL/GLUT-based, non-FRP game engine/framework written in + Haskell. Created by Andre Furtado in 2002, it's the oldest Haskell + game engine, and with very few dependencies and two example games, + it's one of the easiest ways to get started with Haskell game + development. + + The FunGEn library provides: + + * Initialization, updating, removing, rendering and grouping + routines for game objects + * Definition of a game background (or map), including texture-based + maps and tile maps + * Reading and intepretation of the player's keyboard and mouse input + * Collision detection + * Time-based functions and pre-defined game actions + * Loading and displaying of 24-bit bitmap files + * Some debugging and game performance evaluation facilities + + This package receives only basic maintenance (see home page). + stability: alpha cabal-version: >= 1.8 build-type: Simple @@ -19,6 +40,10 @@ data-files: examples/pong/*.bmp, examples/worms/*.bmp + +source-repository head + type: git + location: https://github.com/simonmichael/fungen library ghc-options: -W diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -19,20 +19,21 @@
- +
- +
- +
# Functional Game Engine FunGEn (Functional Game Engine) is a BSD-licensed, cross-platform, -OpenGL/GLUT-based, imperative game engine/framework written in -Haskell. With very few dependencies and two example games, it's one -of the easiest ways to get started with Haskell game development. -It provides: +OpenGL/GLUT-based, non-FRP game engine/framework written in +Haskell. Created by Andre Furtado in 2002, it's the oldest Haskell +game engine, and with very few dependencies and two example games, +it's one of the easiest ways to get started with Haskell game +development. It provides: * Initialization, updating, removing, rendering and grouping routines for game objects @@ -45,59 +46,57 @@ * Some debugging and game performance evaluation facilities -Andre Furtado created FunGEn and I -([Simon Michael](http://joyful.com)) maintain it sporadically. If -you'd like to take it and run with it, or co-maintain, let's chat! I'm -`sm` on the #haskell-game IRC channel. +I ([Simon Michael](http://joyful.com)) provide basic maintenance for +this package. If you'd like to take it and run with it, or +co-maintain, contact me. I'm `sm` on the #haskell-game IRC channel. +On 2014/10/9 I moved it from darcs hub to github. -**Home:** \ -**Hackage:** \ - -**Changelog:** \ -**Code:** \ -**Discussion & help:** - [#haskell-game](http://www.haskell.org/haskellwiki/IRC_channel) IRC channel, - [haskell-cafe](http://www.haskell.org/haskellwiki/Mailing_lists) mail list - \ -**Docs:** - [API docs](http://hackage.haskell.org/packages/archive/FunGEn/0.4.2/doc/html/Graphics-UI-Fungen.html), - Andre's [pong tutorial](site/example.html), - - - Stack Overflow [FunGEn questions](http://stackoverflow.com/search?tab=newest&q=fungen), \ - Haskell wiki [OpenGL tutorial](http://www.haskell.org/haskellwiki/OpenGLTutorial1) \ +**Home:** \ +**Hackage:** \ +**Changelog:** \ +**Code:** \ +\ +**Docs:**\ +  (Latest available) [API docs](http://hackage.haskell.org/packages/archive/FunGEn/0.4.2/doc/html/Graphics-UI-Fungen.html) \ +  Andre's original [pong tutorial](site/example.html) \ +  Haskell wiki [Game_Development](http://www.haskell.org/haskellwiki/Game_Development) \ +  Haskell wiki [OpenGL tutorial](http://www.haskell.org/haskellwiki/OpenGLTutorial1) \ + + +\ +**Discussion & help:**\ +  [#haskell-game](http://ircbrowse.net/day/haskell-game/today/recent) IRC channel + ([join](http://webchat.freenode.net/?channels=haskell-game)) \ +  [FunGEn questions](http://stackoverflow.com/search?tab=newest&q=fungen) on Stack Overflow \ +  [haskellgamedev](http://www.reddit.com/r/haskellgamedev) reddit \ +  [haskell-cafe](http://www.haskell.org/haskellwiki/Mailing_lists) mail list \ ## Getting started -**Install from hackage:** +**Install from hackage, run the examples:** ``` $ cabal update +$ [cabal sandbox init] # if needed, to avoid dependency problems $ cabal install FunGEn +$ fungen-hello # make sure ~/.cabal/bin or ./.cabal-sandbox/bin are in your PATH +$ fungen-pong +$ fungen-worms ``` -**Or, install source and -[run](http://hub.darcs.net/simon/fungen/examples/helloworld.hs) -[the](http://hub.darcs.net/simon/fungen/examples/pong/pong.hs) -[examples](http://hub.darcs.net/simon/fungen/examples/worms/worms.hs):** - +**Contribute patches:** ``` -$ darcs get http://hub.darcs.net/simon/fungen +(Fork https://github.com/simonmichael/fungen) +$ git clone https://github.com/MYUSERNAME/fungen.git $ cd fungen -$ cabal install -$ (cd examples; ghc helloworld; ./helloworld) -$ (cd examples/pong; ghc pong; ./pong) -$ (cd examples/worms; ghc worms; ./worms) +$ cabal sandbox init # if needed, to avoid dependency problems +$ cabal install # install library and examples' data files +(Edit examples/pong/pong.hs) +$ cabal build fungen-pong && dist/build/fungen-pong/fungen-pong +(Commit, push, send pull requests) ``` -(darcs is like git but simpler. If your system doesn't provide it, get it [here](http://darcs.net/Binaries).) - -**Contribute patches:** - -- log in to hub.darcs.net and fork -- push patches to your branch -- give me a "pull request" on #haskell-game ---