A java control that displays as an ascii terminal using code page 437.
Clone or download
trystan Merge pull request #16 from wscarter/patch-1
update readme to include gradle instructions
Latest commit ac179b1 Jun 12, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist added new release Feb 20, 2015
src constructor must be public for this to be useful Mar 18, 2018
.gitignore Updates .gitignore to ignore files for eclipse Oct 19, 2016
.travis.yml Update Travis-CI config Jul 5, 2016
LICENSE.md Fix merge conflict Jul 8, 2016
README.MD fixed a gradle syntax error Jun 12, 2018
pom.xml Added maven-source- and maven-javadoc-plugin Aug 26, 2017

README.MD

AsciiPanel

Build Status

AsciiPanel simulates a code page 437 ASCII terminal display. It supports all 256 characters of codepage 437, arbitrary foreground colors, arbitrary background colors, and arbitrary terminal sizes.

The default terminal size is 80x24 characters and default colors matching the Windows Command Prompt are provided. The default font is 9x16 pixel CP437 (CP437_9x16.)

This should be useful to roguelike developers.

Usage

AsciiPanel supports the customization of fonts. The following system fonts are provided:

  • CP437_9x16
  • CP437_8x8
  • CP437_10x10
  • CP437_12x12
  • CP437_16x16

In addition, the following fontsets from the Dwarf Fortress Tileset are also included:

  • DRAKE_10x10
  • QBICFEET_10x10
  • TALRYTH_15x15

The AsciiPanel class provides a special three-parameter constructor to support font customization. Simply pass the desired AsciiFont as the third parameter as follows.

AsciiPanel myPanel = new AsciiPanel(80, 24, AsciiFont.DRAKE_10x10);

Build instructions

AsciiPanel is a Maven project, compatible with Maven 2 and Maven 3. It can be built using the following command:

mvn install

This will build the project, run the unit tests, and copy the resulting jar into your local Maven repository. Once the jar is deployed to your repository, you can include it in your projects by including the following dependency in your pom:

<dependency>
  <groupId>net.trystan</groupId>
  <artifactId>ascii-panel</artifactId>
  <version>1.1</version>
</dependency>

Or you can add the jitpack repository to your pom:

<repository>
  <id>jitpack.io</id>
  <url>https://jitpack.io</url>
</repository>

which provides AsciiPanel as dependency at:

<dependency>
  <groupId>com.github.trystan</groupId>
  <artifactId>AsciiPanel</artifactId>
  <version>31bc98d</version>
</dependency>

where <version/> describes the git commit you want to use.

For Gradle users:

repositories {
    //...
    allprojects {
        repositories {
            maven { url 'https://jitpack.io' }
        }
    }
}

dependencies {
    //...
    compile 'com.github.trystan:AsciiPanel:master-SNAPSHOT'
}

Notes

This project is built with Java 8. However the code itself does not require Java 8. If you are supporting a project running an earlier version of Java, you can change the pom file and rebuild the jar using your chosen version of Java without having to modify the code.