Skip to content

PixelOn-Project/pixelon-server

Repository files navigation

PixelOn

en kr GitHub release (latest by date)

What is PixelOn?

PixelOn Main

PixelOn is an extension that adds On-Device image generation capabilities to Piskel, the PixelArt Editor. This allows users to create pixel art using AI image generation easily and quickly, anywhere and anytime.

Boost your expressiveness!

We used Stable Diffusion C++ to implement lightweight and fast image generation (4-5 seconds on NVIDIA RTX 3070). Combined with Piskel, it provides a seamless creative experience.

This project was designed and developed to allow anyone to use Generative AI on their own computer as GPU adoption in households increases, moving away from cloud-based generators that require continuous subscription fees.

Key Features

  • AI Image Generation: Generate pixel art via text prompts
  • Compatibility: Fully compatible with existing .piskel files
  • Export: Immediately export generated images to Editor layers

System Requirements (Minimum & Recommended)

Type Minimum Recommended
CPU Intel i5 or higher Intel i5 or higher
RAM 16GB or higher 16GB or higher
GPU NVIDIA RTX 2000 Series (4GB VRAM+) NVIDIA RTX 3070 or higher
Disk 20GB+ Free Space 20GB+ Free Space

Notice 1: CPU-only usage is possible, but it may take 2-3 minutes or more per image. (Approx. 10s on RTX 2060) Notice 2: AMD GPU support will be updated in the future.

Open Source Credits


How to install Piskel & PixelOn?

PixelOn Installer

  1. Click Download PixelOn Installer to get the installation file.
  2. Run the installer to automatically scan your system and select the optimal acceleration version (CUDA, etc.).
  3. Once installation is complete, run PixelOn from your desktop.

Q & A

  • Q. I have an Nvidia GPU but CUDA is not selected.
  • Q. I have an AMD GPU, but ROCm is not selected or errors occur during execution.
    • A. Your GPU driver might be outdated. Please update to the latest version at AMD Drivers Support.
    • A. Additionally, ROCm support is currently experimental due to limited testing environments. Please let us know if you encounter any issues!
  • Q. It says "Server Connection Failed".
    • A. There may be missing files due to network issues during installation. Please reinstall via the installer.
  • Q. Generation speed is too slow.
    • A. Speed can be slow if you don't have a GPU accelerator or meet the specs. This is a physical limitation of local execution.
  • Q. How do I uninstall PixelOn?
    • A. You can uninstall it by running PixelOn Installer.exe again, or by searching for PixelOn in Windows Settings > Apps > Installed apps.

How to Use PixelOn?

1. Piskel Editor

When you run PixelOn, the Piskel editor screen appears. You can perform dot work just like existing Piskel usage. For detailed usage, please refer to the Piskel Official Guide.

2. Simple Prompt

Simple Prompt UI You can quickly generate images using the prompt window at the bottom of the editor. Only Positive Prompts can be entered in this window.

3. Detail Dialog

Detail Dialog UI Open the Detail window for more precise work. Detailed descriptions of each component are below.


History UI

ⓐ History Management

Manage previous work sessions in the History tab.

  • Click Session: View past generation records.
  • ... Button: Rename or delete the session.
  • Warning: Deletion cannot be undone (Undo), so please decide carefully.

Settings UI

ⓑ Prompt & Settings

Manipulate key settings for image generation.

  • Positive Prompt: Scene description (Tag format, separated by Enter)
  • Negative Prompt: Elements to exclude (e.g., low quality)
  • Preset: Select model preset (Normal, Pixel Art, etc.)
  • Resolution / Count: Adjust image size and count
Note: If the resolution is too small, the image may not generate correctly.

Results UI

ⓒ Results

Check and manage generated images.

  • Left Click: Select image
  • ... Click (Top of Image):
    • Transfer: Load settings from generation time
    • Delete: Delete the image
  • Cancel: Deselect image
  • Delete Selected: Delete selected images in bulk
Warning: Deletion cannot be undone.

Log UI

ⓓ Log, Expert

Check logs or send images to Editor.

  • Move To Frame: Exports selected images as New Frames respectively. (Useful for multi-image work)
  • Move To Layer: Exports the last selected image to the Current Layer. (Useful for single image work)


Usage Tips

1. Prompt Tag Input

PixelOn uses multiple tags to compose prompts. After entering text, press the Enter key to register a tag. The entered tags are internally connected and used for image generation.

Simple Prompt UI

2. Effective Prompt Writing

Prompt Writing Tips

  • Don't make it too complex: Each tag should be written as a noun or adjective + noun, preferably within 3-4 words.
  • Set appropriate resolution: Resolutions smaller than 64x64 make it difficult to express details.
    • For General, Character, SD Character models, 64x64 is recommended.
    • For Background models, 128x128 is recommended.
  • Try multiple times: AI generation is probabilistic, so the same prompt can produce different results each time.
  • Tag order matters: Tags positioned earlier have a greater influence on image generation.
  • Use Negative Prompts: Specifying unwanted elements (e.g., garish, amateur) improves quality.

Prompt Examples

Example 1

Preset: General
Resolution: 64x64
Positive Prompt: cat fluffy fur sitting on grass
Negative Prompt: -

Example 2

Preset: Character
Resolution: 64x64
Positive Prompt: girl long hair blonde hair pretty face smiling
Negative Prompt: -

Example 3

Preset: SD Character
Resolution: 64x64
Positive Prompt: girl twin tails red and white dress cute pose
Negative Prompt: -

Example 4

Preset: Background
Resolution: 128x128
Positive Prompt: mountain landscape snow peaks clear sky pine trees sunrise
Negative Prompt: -

3. AI Models Used

PixelOn utilizes the following open-source AI models:

Each model follows its respective license. Please check each model's license for commercial use.

Each preset uses the following model combinations:

  • General: Cetus-Mix base + pixelartredmond-1-5v-pixel-art-loras-for-sd-1-5 LoRA
  • Character: Cetus-Mix base + 8bitdiffuser 64x LoRA
  • SD Character: QteaMix base + 8bitdiffuser 64x LoRA
  • Background: Cetus-Mix base + pixel world LoRA

Development Environment

Prerequisites

  • Windows OS
  • Python >= 3.10
  • Node.js (We build on Python 3.14 and Node 24.11.1)

How to setup

  1. Prepare an environment that meets the above prerequisites.
  2. Run bootstrap.bat to install necessary dependencies.
    • Includes: Stable Diffusion C++, Piskel (Forked Repo), AI Models
  3. Run python app.py to start the local server.

Contribute

Please use the dev branch if you want to contribute. Pull Requests are always welcome!

License

This project follows the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors