Index of /~eslaughter/darcs/blackthorn

Name	Last modified	Size

Parent Directory		-
w32/	2009-05-25 06:46	-
unix/	2009-05-31 06:46	-
src/	2009-05-04 06:46	-
sprofile.lisp	2009-05-24 02:02	2.2K
property.lisp	2009-05-24 02:02	2.1K
profile.lisp	2009-05-24 02:02	2.5K
macos/	2009-05-30 23:29	-
load.lisp	2009-05-24 02:02	2.0K
dist.lisp	2009-05-24 02:02	5.3K
disp/	2009-05-04 06:46	-
cldoc.lisp	2009-01-05 07:14	2.1K
bunnyslayer.asd	2009-06-07 03:08	2.8K
blackthorn.asd	2009-06-07 03:08	3.8K
atdoc.lisp	2009-02-08 00:18	2.9K
_darcs/	2009-10-04 08:08	-
README.html	2009-05-04 06:46	8.2K
README.arc	2009-05-04 06:46	13K
Makefile	2009-07-07 05:59	7.5K
COPYRIGHT	2009-01-05 07:14	1.3K

What is Blackthorn?

Blackthorn is a framework for writing 2D games in Common Lisp. Blackthorn is attempt to write an efficient, dynamic, persistent 2D game engine in an expressive language which makes it easy to write games.

Why another game engine?

Games are hard to write. The effort needed to write a usable game engine from scratch, especially when dealing with the low-level details of languages like C, make the cost of writing games prohibitive. Libraries like SDL get many of the driver-level graphics details out of the way, but still leave the user writing in C. Libraries like PyGame and LISPBUILDER-SDL wrap more of these low-level details, but still don't provide a full game engine needed for writing substantial games.

There are, of course, game engines which provide this functionality to the user. Game Maker, for example, is an engine which provides everything needed to make a basic game, and an extention language for writing more complex behavior. Using Game Maker, an experienced user can write a basic game in five minutes. However, Game Maker (and similar programs the authors have tried) have some substantial flaws. Problems with Game Maker, specifically, include:

Game Maker only runs on Windows. A Linux port is still a dream, and porting to any sort of mobile device is completely unimaginable.
Game Maker's extension language, GML, is a kludge, and inefficient. (The lack of a rich set of built-in datastructures is something I hear GML users complaining about frequently.)
Game Maker is closed source, so it would be impossible for anyone other than the authors to fix any of the above problems with Game Maker.

What does Blackthorn provide?

Blackthorn attempts to fix many of the problems above. Blackthorn provides:

A not-yet-complete subset of the functionality provided by Game Maker. Despite being incomplete, Blackthorn is already capable of supporting simple games.
Blackthorn is written in Common Lisp, providing:
- Efficiency which is (depending on the implementation, and the benchmark) capable of competing with C.
- Portable to any platform supported by a compliant ANSI Common Lisp compiler. Blackthorn currently runs on Windows, Linux, and Mac OSX. Porting Blackthorn to a new compiler takes a couple of hours.
- Dynamic behavior, because the entire compiler is available at runtime. An on-screen development REPL (read-eval-print loop, i.e. a development console) with an on-screen debugger is provided, giving the user the ability to rewrite arbitrary pieces of code on the fly.
- Extensibility, because the game engine itself is an open platform, and because user code operates at the same level as the game engine.
- And finally, because Blackthorn is open source, it is open to improvements from the community.

Details

Blackthorn uses LISPBUILDER-SDL for graphics support (which internally uses SDL, SDL_image, and SDL_gfx), and either AllegroCache, Elephant, or CL-STORE as an internal database for object persistence.

Blackthorn currently runs on Windows, Linux, and Mac OSX, under Allegro CL, SBCL, CLISP, and ECL. Blackthorn is tested semi-regularly with the following configurations:

Windows x86/Allegro CL/CL-STORE
Windows x86/SBCL/CL-STORE
Windows x86/CLISP/CL-STORE
Linux x86 and x86-64/SBCL/CL-STORE
Mac OSX x86/SBCL/CL-STORE

Other configurations which have worked in the past, but haven't necessarily been tested recently include:

Windows x86/Allegro CL/AllegroCache
Windows x86/SBCL/Elephant (BDB)
Linux x86 and x86-64/SBCL/Elephant (BDB)
Linux x86-64/ECL/CL-STORE

Note: As the games using Blackthorn have become increasingly complex, the load Blackthorn puts on its backing DB has become an increasing performance issue. Currently, the only configuration which runs with a decent frame rate is CL-STORE, because both AllegroCache and Elephant access the disk excessively. Solutions for speeding up either DB are being looked into (e.g. Elephant's Snapshot Set), but none are currently usable.

Prerequisites

The following are required for developing with Blackthorn with the CL-STORE backend.

A compatible Lisp compiler:

Among the compatible compilers, SBCL is suggested because it is (a) free and open source, (b) compatible with Windows, Linux and Mac, and (c) has the best performance of the compilers listed. Allegro CL is also a good choice, but is commercial software (although a free version is available).

Direct dependencies:

Windows only (optional):

Cygwin or GnuWin32 to use the Makefile
NSIS for building installers

Installation

Download the source using darcs

darcs get http://common-lisp.net/~eslaughter/darcs/blackthorn

To start Blackthorn from the shell, merely call make

make

Optionally, use parameters to specify the build environment, e.g.

make cl=sbcl db=nodb driver=load.lisp system=bunnyslayer

If instead you prefer to start Blackthorn interactively, start your Lisp and

(load "load")

Download

Binary distributions are made semi-frequently and are available for download at http://elliottslaughter.net/bunnyslayer/download.

License

Blackthorn is free and open source software, see the COPYRIGHT file for details.

Index of /~eslaughter/darcs/blackthorn

Blackthorn: Lisp Game Engine