README.mdown


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

# What is GIMPixel?

GIMPixel is a set of brushes, palettes, and image templates designed to turn [GIMP](http://gimp.org) into an enjoyable piece of pixeling software. It's still in its infancy, so if you know a thing or two about configuring GIMP or would like to contribute brushes, palettes, or more, don't hesitate to join in!

For a quick look at what GIMPixel provides, check out the `features.png` file:

![A summary of features that GIMPixel offers](https://github.com/sporkbox/gimpixel/raw/master/features.png "Isn't it awesome?")

## Usage
To use GIMPixel, you must run GIMP after changing the "GIMP2\_DIRECTORY" environment variable. To do so, just run something like `GIMP2_DIRECTORY=.gimpixel gimp` and it should work without messing with your existing GIMP configuration.

If you decide that you'd like to replace your existing GIMP configuration with GIMPixel, just move .gimpixel to your original GIMP directory (usually .gimp-2.x/)

### Fluxbox
Adding the following to ~/.fluxbox/menu should work:  
`[exec] (GIMPixel) {GIMP2_DIRECTORY=~/.gimpixel gimp}`

### Bash script
Put the following into a text file and save it as an executable shell script:

    #!/bin/bash
    export GIMP2_DIRECTORY=~/.gimpixel
    exec gimp

Name it something like `gimpixel` and you'll have a quicklauncher.

# Roadmap
* Support color bit-depth setting
* Provide execution directions for other common window managers or environments.
* Add some additional interesting or useful brushes.