Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SkyAphid authored Jul 26, 2018
1 parent 4d95ad5 commit 918bcfe
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# PaletteSwapper
A small tool that allows you to change the palettes of multiple image files.
![rock example](https://user-images.githubusercontent.com/6147299/43259782-1362a72a-909d-11e8-8054-eb8216f421c3.png)

A small tool that allows you to change the palettes of multiple image files.

## Examples
When you run Palette Swapper, it will first ask for a palette definitions text file, and then some images to edit. Multiple palette files and images can be inputted at once.

Palette Swapper has two syntax types for palette definitoons: Brasch syntax and Worms syntax. By default, it will use Brasch syntax. Below are links to examples on making your own palette definitons.

[Brasch Syntax Mode Example File](https://github.com/SkyAphid/PaletteSwapper/blob/master/PaletteSwapper/RockPaletteVerBrasch.txt)
[Worms Syntax Mode Example File](https://github.com/SkyAphid/PaletteSwapper/blob/master/PaletteSwapper/RockPaletteVerWorms.txt)

## Dependencies and Running
Palette Swapper uses Java 1.8

[To run Palette Swapper, simply install Java and then run the JAR.](https://java.com/en/download/)

0 comments on commit 918bcfe

Please sign in to comment.