<img src="https://raw.githubusercontent.com/pixelpen-dev/pixelpen/main/screenshot.png">

# PixelPen

PixelPen is a free and open-source pixel art editor, created with the Godot Engine. PixelPen can be used both as a Godot addon and as a standalone application. It is written in GDScript and C++ as a GDExtension plugin.

## How to Use

### Plugins:
- Download the release version of this project from the [Releases page](https://github.com/pixelpen-dev/pixelpen/releases).
- Alternatively, download it directly from [AssetLib](https://godotengine.org/asset-library/asset/3023).
- Ensure the plugin directory is `addons/net.yarvis.pixel_pen`.

> [!TIP]
> - Disable single window mode in editor. When PixelPen launch, it will be in separate window.
> - Use pen tablet driver to `wintab` for windows in project settings.
> - You can also use our recent commit build here [Artifact](https://github.com/pixelpen-dev/pixelpen/actions). Please be careful, make sure to backup your project first before using it.

### Build from Source (Optional):
- Refer to the official [GDExtension documentation](https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/gdextension_cpp_example.html).
- Clone this project: `https://github.com/pixelpen-dev/pixelpen.git`.
- (Optional) Use the `tools/build.sh` script to build the project.

## Web Demo

This is just a preview, some features may not work properly.

- [pixelpen-dev.github.io](https://pixelpen-dev.github.io/)

## Credit
Developed for the Godot community by:

|||
|--|--|
| **Bayu SW, Yarvis Games** | [<img src="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/icons/twitter-x.svg" width="24"/>](https://x.com/yarvisdev) [<img src="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/icons/github.svg" width="24"/>](https://github.com/bayu-sw) [<img src="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/icons/globe.svg" width="24"/>](https://yarvis.net/) |

See more contributor in [AUTHOR.md](https://github.com/pixelpen-dev/pixelpen/blob/main/AUTHOR.md)


## Licensing

MIT (See the [COPYRIGHT](https://github.com/pixelpen-dev/pixelpen/blob/main/COPYRIGHT.txt) file for more information)


> [!NOTE]
>To use PixelPen as an application, select `res://addons/net.yarvis.pixel_pen/editor/editor_main_ui.tscn` as your main scene and export the project to your preferred platform.
