README.md

   1 # README
   2
   3 musk is an adventure game engine using [Lua](http://www.lua.org/) and the [SDL](http://www.libsdl.org/). It's only available on Mac OS X for the moment, but will be available on Linux (and Windows if I can).
   4
   5 It will be a mix between [SCUMM](http://en.wikipedia.org/wiki/SCUMM) and [GrimE](http://en.wikipedia.org/wiki/GrimE) (but it will be written from scratch). It will allow people to write simple (and maybe complex) adventure games in the spirit of [Monkey Island](http://en.wikipedia.org/wiki/Monkey_Island_\(series\)) or [Maniac Mansion](http://en.wikipedia.org/wiki/Maniac_Mansion).
   6
   7 Don't be shy, post your bugs or suggestions in the [bug tracker](http://github.com/exterlulz/musk/issues).
   8
   9 Don't forget to look at [Grail](http://github.com/Droggelbecher/Grail) which is a project way more advanced than mine!
  10
  11 # Scripting example (not available yet)
  12
  13     -- the configuration table
  14     CONFIG = {
  15       fps = 30,
  16       width  = 800,
  17       height = 600,
  18     }
  19
  20 # Links
  21
  22 - [home page](http://www.exterlulz.net/musk/)
  23 - [wiki](http://github.com/exterlulz/musk/wiki)
  24 - [bug tracker](http://github.com/exterlulz/musk/issues)
  25 - [git mirror](http://repo.or.cz/w/exterlulz-musk.git)
  26
  27 # Licenses
  28
  29 ## Lua
  30
  31 Copyright (c) 1994–2008 Lua.org, PUC-Rio.
  32
  33 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  34
  35 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  36
  37 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.