Skip to content
This repository has been archived by the owner on Jan 7, 2025. It is now read-only.

Commit

Permalink
Write README
Browse files Browse the repository at this point in the history
  • Loading branch information
MoreFoxBeans committed Sep 9, 2022
1 parent 364a9f2 commit 28ff716
Showing 1 changed file with 48 additions and 1 deletion.
49 changes: 48 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,49 @@
# pixelart.koplugin
Pixel art plugin for KOReader

A WIP pixel art editor plugin for KOReader! I've only tested this on my personal reader so it please create an issue if something doesn't work.

## How to install

Download the source code of the [latest release](https://github.com/MoreFoxBeans/pixelart.koplugin/releases), then extract that to get a folder named "pixelart.koplugin". Move that folder into the KOReader plugins directory, (it varies per device but for Kobo readers it's "~/.adds/koreader/plugins"). Restart KOReader and you're done!

## Where do I find it?

It should be located in the "More tools" section of the plugins section of the KOReader menu. If you can't find it, make sure you have restarted KOReader before creating an issue.

## Tools

- Menu
- Change image size
- Change grid size
- New image
- Save image
- Open image
- Quit
- Pencil
- Eraser
- Picker
- Line
- Rectangle
- Circle
- Fill
- Fill 8 directions
- Fill 4 directions
- Replace all colors
- Pan
- View
- Zoom out
- Zoom in
- Fit to screen
- Toggle grid
- Refresh screen
- Brush size
- Lots of them!
- Brush color
- Colors (note that some may look similar on older devices)
- Enable/disable shape fill

## Screenshots

![https://raw.githubusercontent.com/MoreFoxBeans/pixelart.koplugin/main/screenshots/space.png]()

![https://raw.githubusercontent.com/MoreFoxBeans/pixelart.koplugin/main/screenshots/gridsize.png]()

0 comments on commit 28ff716

Please sign in to comment.