Clean up README for migration to sr.ht
Merge pull request #1 from technomancy/appimage-compatibility
Don't assume PWD is the checkout root.
This is my entry to this year's Autumn Lisp Game Jam. The dialect of Lisp I chose to use for this entry was Fennel, a simple and elegant Lisp that I feel perfectly matches the simplicity and elegance of Lua. The theme was slime, so it's a game about covering everything in sight with slime. As of right now, this has the distinct charm of a demo that was far too ambitious and rushed to be much more than a buggy proof of concept, but I do hope that enjoy it in some capacity.
The game's code is licensed under version 3 of the GNU General Public License,
and the artwork in art/ with the exception of font.png is licensed under the
Creative Commons Attribution-ShareAlike 4.0 International License. A copy of the
GPL is available at LICENSE, and to view a copy of the CC BY-SA 4.0, visit
http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative
Commons, PO Box 1866, Mountain View, CA 94042, USA. The contents of music/ are
in the public domain, and the art/font.png is licensed under the CC0.
You will need the LÖVE2D engine. Once you've obtained that, you can run the following from the root directory:
love .
You can move laterally with the left and right arrow keys, jump with the 'z' key, and spew balls of slime with the 'x' key.
I'm totally new to LÖVE and Fennel, so I borrowed a lot of the boilerplate from his entry to the Lisp Game Jam 2018, EXOencounter 667. His post, "in which a game jam is recounted further", also served as excellent guidance in navigating the API's for LÖVE as well as a few other excellent Lua libraries, listed below.
Of lume.lua, which provides some very pleasant functional constructs such
as map, as well as typical linear interpolation and vector math. lume is
released under the MIT license.
Of bump.lua, a much simpler library for collision detection than the one provided by LÖVE. bump.lua is released under the MIT license.
Of the Boxy Bold Font that I used in this game. The font is licensed under CC0.
I really did fall in löve with the LÖVE API's.
Of sfxr, the tool I used to produce the jumping and spitting sound effects. sfxr is released under the MIT license.
The wonderful chiptunes are, sadly, not my own. To fit into the requirement that all existing assets be free for others to use as well, I only picked modules that were licensed in the public domain. Among them: