ALttPJ - a Java library for Zelda 3: A Link To The Past Rom manipulation

Common Library Functions such as Sprite to Image conversion, compression, etc. This is useful if you are developing a ROM tool and need to:

Convert PNG Images to sprites to include them into the game.
Convert sprites to PNG images for a preview.
Read uncompressed data
Compress data for inclusion into the game

How to use

You can use the Maven github repository.

Coordinates will be:

<project>
  <!-- … -->

  <dependencies>
    <!-- https://github.com/alttpj/alttpj-library -->
    <dependency>
      <groupId>io.github.alttpj.library</groupId>
      <artifactId>alttpj-library</artifactId>
      <version>1.0.0-SNAPSHOT</version>
    </dependency>
  </dependencies>

  <!-- … -->

  <repositories>
    <repository>
      <id>github</id>
      <name>GitHub alttpj-library Apache Maven Packages</name>
      <url>https://maven.pkg.github.com/alttpj/alttpj-library</url>
      <releases><enabled>true</enabled></releases>
      <snapshots><enabled>true</enabled></snapshots>
    </repository>

  </repositories>

</project>

The root package is: io.github.alttpj.library

Compression

SnesCompressor-- compression SnesDecompressor-- decompression

Image manipulation

Use ImageIO (tbd). .zspr files will be supported later on. Current state: Read images with the green palette which are 128x32.

Runtime Dependencies

None. This project will get rid even of the slf4j dependency once "finished".

Installation

See INSTALL.

Roadmap

Things which need to be done:

(Maybe) Use imageIndex for the tiles in Alttp3bppImageReader
Add more formats, e.g. one format which includes the palette index.
See issues and CONTRIBUTING if you want to help out.
Your help is very much appreciated!

Recommend Projects