Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mitchcurtis/slate

Pixel Art Editor
https://github.com/mitchcurtis/slate

2d-animation bitmap-editor game-development pixel-art pixel-art-editor qt qt5 qtquick qtquick-controls2 sprite sprites tilesets

Last synced: 4 days ago
JSON representation

Pixel Art Editor

Awesome Lists containing this project

README

        

# Slate - Pixel Art Editor



Slate is a bitmap editor available for Linux, Windows and Mac. With Slate, you can:

- Edit images directly
- Use layers
- Create seamless 2D tilesets
- Preview sprite sheet animations

Slate was built for pixel art, and its goal is to simplify the creation of sprites and tilesets by offering a user-friendly, customisable interface.

# Contents

- [Screenshots](#screenshots)
- [Downloads](#downloads)
- [Installing](#installing)
- [Documentation](#documentation)
- [Discussion](#discussion)
- [Donations](#donations)
- [Building From Source](#building-from-source)
- [Dependencies](#dependencies)
- [Cloning](#cloning)
- [Building](#building)
- [Qt Creator](#qt-creator)
- [Command Line](#command-line)
- [Qbs](#qbs)
- [CMake](#cmake)

### Screenshots

![Screenshot of Slate on Linux](https://github.com/mitchcurtis/slate/blob/release/doc/images/slate-v0.1.0-tileset-linux.png "Screenshot of Slate on Linux")

![Screenshot of Slate v0.4.0 on Mac](https://github.com/mitchcurtis/slate/blob/release/doc/images/slate-v0.4.0-layers-mac.png "Screenshot of Slate v0.4.0 on Mac")

![Screenshot of Slate v0.4.0 on Mac](https://github.com/mitchcurtis/slate/blob/release/doc/images/slate-v0.4.0-animation-mac.png "Screenshot of Slate v0.4.0 on Mac")

### Downloads ###

- [Slate 0.9.0 for Linux](https://github.com/mitchcurtis/slate/releases/download/v0.9.0/Slate-v0.9.0-linux.tar.xz)

- [Slate 0.9.0 for Mac](https://github.com/mitchcurtis/slate/releases/download/v0.9.0/Slate-v0.9.0-mac.dmg)

- [Slate 0.9.0 for Windows](https://github.com/mitchcurtis/slate/releases/download/v0.9.0/Slate-v0.9.0-windows.zip)

See the [releases](https://github.com/mitchcurtis/slate/releases) page for the full list of available downloads.

Note that the Linux binaries are built on Ubuntu 18.04.3 and may not work with other distributions. If you encounter issues running Slate on Linux, try [building from source](#building-from-source).

### Installing ###

All Slate builds are portable, meaning that no installation is necessary. On Windows, however, it may be necessary to run the vc_redist.x64.exe file that comes with the download in order to install certain Microsoft C++ libraries if you've never installed any applications that require this prior to running Slate.

### Documentation ###
- [Overview](https://github.com/mitchcurtis/slate/blob/release/doc/overview.md)

### Discussion ###

Join Slate's Discord server for discussion: https://discord.gg/ZtAAg5D

It's fine to ask questions here on GitHub as well - just [create an issue](https://github.com/mitchcurtis/slate/issues/new) and I will label it accordingly.

### Donations ###

If you like Slate, feel free to stop by the Discord server and let me know. I'm always excited to know that people are using it.

You can also say thank you by donating via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=LLLVPKU2JW9P8&source=url) or [itch.io](https://mitchcurtis.itch.io/slate).

## Building From Source ##

### Dependencies ###

* Qt 6.5

Note that the dependencies above are for the current branch that you are viewing, and GitHub shows the master branch by default. If you want to build the latest stable release, see https://github.com/mitchcurtis/slate/tree/release#dependencies.

### Cloning ###

`master` is the branch where development is done, and `release` is the stable branch where releases are made from. I also [tag](https://github.com/mitchcurtis/slate/tags) releases.

Initialise the submodules after cloning:

git submodule update --init

### Building ###

Slate can be built with Qbs or CMake.

#### Qt Creator ####

It's recommended to build using Qt Creator for convenience.

Open [slate.qbs](https://github.com/mitchcurtis/slate/blob/release/slate.qbs) or [CMakeLists.txt](https://github.com/mitchcurtis/slate/blob/master/CMakeLists.txt) in Qt Creator, configure the project using a kit with a Qt version that meets the requirement listed in the [Dependencies](#dependencies) section, and then build it.

#### Command Line ####

##### Qbs

First, follow Qbs' [setup guide](http://doc.qt.io/qbs/setup.html). Once you've set it up, choose one of the following approaches.

In-source builds:

cd /path/to/slate-source-dir
qbs

Shadow builds:

mkdir slate-build
cd slate-build
qbs /path/to/slate-source-dir/slate.qbs

For more information about building Qbs applications, see [this page](http://doc.qt.io/qbs/building-applications.html).

##### CMake

In-source builds:

cd /path/to/slate-source-dir
cmake .
cmake --build .

Shadow builds:

mkdir slate-build
cd slate-build
cmake /path/to/slate-source-dir
cmake --build .

To run all test cases:

cd slate-build
ctest

---

List of assets used in the screenshots:

- https://opengameart.org/content/lpc-tile-atlas
- https://opengameart.org/content/pixel-explosion-12-frames

OS icons taken from [font-os](https://github.com/JeyKeu/font-os).