Pixelorama Documentation

repository·master·Indexed 27 days ago

https://github.com/orama-interactive/pixelorama

A pixel art editor featuring integrated addons such as aimgio, Keychain, gdgifexporter, godot-dockable-container, and SmartSlicer. Documentation covers addon customizations, localization via .po files and Crowdin, and instructions for building click packages for Ubuntu Touch using the Clickable tool.

Tokens
845
Snippets
3
Records
9
Agent score
95%

What's inside Pixelorama

  1. Overview of Pixelorama Addons

    master
    Pixelorama utilizes several third-party addons and plugins to extend its functionality. These include tools for image I/O, Android app links, keychain management, GIF exporting, UI container docking, and slicing. Many of these are modified versions of upstream projects to ensure compatibility with Pixelorama's specific requirements and layout.
  2. Build for multiple architectures using CLICKABLE_ARCH

    master

    By default, clickable build uses the standard architecture. To build for specific architectures like armhf or arm64, set the CLICKABLE_ARCH environment variable before running the build command. It is recommended to provide packages for both armhf and arm64.

    $ CLICKABLE_ARCH=armhf clickable build
    $ CLICKABLE_ARCH=arm64 clickable build
  3. Build Ubuntu Touch click packages

    master

    To create a click package for Ubuntu Touch, follow these steps to prepare the files and run the build command:

    1. Export the project pack file using the "Clickable (package only)" preset.
    2. Copy the resulting .pck file from your export directory (e.g., dist/linux) into the Misc/Clickable directory and rename it to Pixelorama.pck.
    3. Copy the pixelorama_data directory from the project root into the Misc/Clickable directory.
    4. Navigate to the directory and run the build command via the terminal.

    The resulting click file will be located in the Misc/Clickable/build directory.

    $ cd Misc/Clickable
    $ clickable build
  4. Customizations in godot-dockable-container

    master

    The version of godot-dockable-container used in Pixelorama is based on upstream but includes specific modifications to layout.gd and other files.

    New/Modified features in layout.gd include:

    • Variables: save_on_change, layout_reset_path.
    • Methods: save(), copy_from(), reset().
    • A setter method for layout_split.

    Other changes:

    • set_split_cursor() has been deleted in split_handle.gd.
    • Bug fixes applied to dockable_container.gd and dockable_panel.gd.
  5. Reference list of Pixelorama Addons

    master

    The following addons are integrated into Pixelorama:

    • aimgio: Image I/O functionality.
    • applinks: Android Applinks plugin.
    • Keychain: Keychain management.
    • gdgifexporter: GIF exporting functionality.
    • godot-dockable-container: UI docking system.
    • SmartSlicer: Slicing functionality.
  6. Customizations in SmartSlicer

    master

    The SmartSlicer addon is used with specific modifications for better organization within Pixelorama:

    • The script SmartSlicePreview.gd has been modified (lines 31-32).
    • For organizational purposes, SmartSlicePreview.gd is located at res://src/UI/Dialogs/HelperScripts/ instead of the standard addons folder.