Pixelorama Documentation
repository·master·Indexed 27 days ago
https://github.com/orama-interactive/pixeloramaA 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.
What's inside Pixelorama
- 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.
Build for multiple architectures using CLICKABLE_ARCH
masterBy default,
clickable builduses the standard architecture. To build for specific architectures likearmhforarm64, set theCLICKABLE_ARCHenvironment variable before running the build command. It is recommended to provide packages for botharmhfandarm64.$ CLICKABLE_ARCH=armhf clickable build $ CLICKABLE_ARCH=arm64 clickable buildContribute translations via Crowdin
masterTo contribute translations to Pixelorama, do not open pull requests directly to the GitHub repository. Instead, use the official Crowdin project page. Crowdin is the designated web-based platform for collaborative translation efforts.
https://crowdin.com/project/pixeloramaBuild Ubuntu Touch click packages
masterTo create a click package for Ubuntu Touch, follow these steps to prepare the files and run the build command:
- Export the project pack file using the "Clickable (package only)" preset.
- Copy the resulting
.pckfile from your export directory (e.g.,dist/linux) into theMisc/Clickabledirectory and rename it toPixelorama.pck. - Copy the
pixelorama_datadirectory from the project root into theMisc/Clickabledirectory. - Navigate to the directory and run the build command via the terminal.
The resulting click file will be located in the
Misc/Clickable/builddirectory.$ cd Misc/Clickable $ clickable buildLocalize Keychain using .po files
masterKeychain supports localization via.pofiles using thegettextsystem. To add support for a new language, simply add a.pofile for that language to the Keychain directory. The project automatically registers these files with theTranslationServerat runtime.File loading and saving restrictions on Ubuntu Touch
masterDue to AppArmor policy restrictions on Ubuntu Touch, the application is restricted from saving files anywhere outside of the user data directory.Customizations in godot-dockable-container
masterThe version of
godot-dockable-containerused in Pixelorama is based on upstream but includes specific modifications tolayout.gdand other files.New/Modified features in
layout.gdinclude:- 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 insplit_handle.gd.- Bug fixes applied to
dockable_container.gdanddockable_panel.gd.
- Variables:
Reference list of Pixelorama Addons
masterThe 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.
Customizations in SmartSlicer
masterThe
SmartSliceraddon is used with specific modifications for better organization within Pixelorama:- The script
SmartSlicePreview.gdhas been modified (lines 31-32). - For organizational purposes,
SmartSlicePreview.gdis located atres://src/UI/Dialogs/HelperScripts/instead of the standard addons folder.
- The script