Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 2.13 KB

README.md

File metadata and controls

70 lines (44 loc) · 2.13 KB

quip

Clojars Project

A Clojure game engine made using Quil.

Quick start

The easiest way to get going is to use the quip Leiningen template:

lein new com.github.kimbsy/quip <project-name>

This will create a game project containing two scenes, menu and level-01.

you can run your game locally with Leiningen:

lein run

Or from the repl:

(-main)

You can build your game as a .jar for distribution.

# build
lein uberjar

# run
java -jar target/uberjar/<project>-<version>-standalone.jar

Slower start

For a guide to the basics check out the Wiki

Taking a look at the example games gives a few simple demonstrations of how to use animated sprites, basic music and sound effects, and others.

For more advanced examples feel free to check out these games on Itch.io

⚠️ These games were all made for game jams under tight time constraints, so the code is of ... mixed quality.


Documentation

You can generate function-level documentation for quip locally using Codox:

lein codox

License

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.