https://github.com/kelsey-sorrels/zaffre

A fast clojure console library
https://github.com/kelsey-sorrels/zaffre

clojure console lwjgl terminal tilesets

Last synced: about 2 months ago
JSON representation

A fast clojure console library

• Host: GitHub
• URL: https://github.com/kelsey-sorrels/zaffre
• Owner: kelsey-sorrels
• License: mit
• Created: 2016-02-13T21:29:23.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-12-05T04:49:44.000Z (about 1 year ago)
• Last Synced: 2024-05-19T05:04:53.705Z (8 months ago)
• Topics: clojure, console, lwjgl, terminal, tilesets
• Language: Clojure
• Size: 1.07 MB
• Stars: 101
• Watchers: 4
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zaffre

## A fast Clojure library for emulating a terminal

Zaffre is fast console library for drawing characters to a screen.



## Features

  * It's fast. Zaffre uses LWJGL and OpenGL to render characters as fast as possible.

  * Unicode support (minus CJK code points)

  * CP437 tileset support (eg: loading [Dwarf Fortress Wiki: Tileset repository](http://dwarffortresswiki.org/index.php/Tileset_repository))

  * Cross-platform codebase

  * Thread safe

  * Multiple fonts

  * Glyph stacking

  * Non-character tiles ie: sprites

  * Mix different font sizes



## Not Features

  * Effects

  * Animation

  * GUI control emulation

## Usage

Add the dependency to your project:

```clojure

[zaffre "0.4.0-SNAPSHOT"]

```

## Quickstart

Runs a little hello world terminal

```clojure

(ns examples.basic

  (:require [zaffre.terminal :as zat]

            [zaffre.glterminal :as zgl]

            [zaffre.events :as zevents]

            [zaffre.font :as zfont]

            [zaffre.tilesets :as ztiles]

            [zaffre.util :as zutil]

            [clojure.core.async :as async :refer [

## More Examples

Run with

`lein run -m examples.basic`

or

`lein run -m examples.tileset`

etc.

Got to https://github.com/kelsey-sorrels/zaffre/tree/master/src/examples for more.

## License

Copyright © 2016 Kelsey Sorrels

Distributed under the MIT license.

## YourKit

![](https://www.yourkit.com/images/yklogo.png)

Many thanks to YourKit for providing this project with licenses of its profiler to help us improve performance!

YourKit supports open source projects with innovative and intelligent tools

for monitoring and profiling Java and .NET applications.

    YourKit is the creator of [YourKit Java Profiler](https://www.yourkit.com/java/profiler/),

    [YourKit .NET Profiler](https://www.yourkit.com/.net/profiler/) and

    [YourKit YouMonitor](https://www.yourkit.com/youmonitor), tools for profiling Java and .NET applications.