mirror
/
pixel-editor
mirror of https://github.com/lospec/pixel-editor.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
pixel-editor/README.md

2.5 KiB
Raw Blame History

Lospec Pixel Editor

This is a browser based software for creating pixel art

The tool can be viewed online here: https://lospec.com/pixel-editor

What to Contribute

Any changes that fix bugs or add features are welcome.

The next version is mostly focused on adding missing essential features and porting to mobile.

Suggestions / Planned features:

  • Documentation

  • Possibility to hide and resize menus (layers, palette)

  • Line tool

  • Tiled mode

  • Load palette from LPE file

  • Symmetry options

  • Mobile

    • Touch equivalent for mouse clicks
    • Hide or scale ui
    • Maybe rearrange UI on portrait
    • Stack colors when too many
    • Fix popups

  • Possibly add collaborate function

  • Polish:

    • ctrl a to select everything / selection -> all, same for deselection
    • Warning windows for wrong inputs
    • Palette option remove unused colors
    • Move selection with arrows
    • Update borders by dragging the canvas' edges with the mouse when resizing canvas
    • Move the canvases so they're centered after resizing the canvas (maybe a .center() method in layer class)
    • Scale selection

How to Contribute

Requirements

You must have node.js and git installed.

You also need npm in version 7 (because of 2nd version of lockfile which was introduced there) which comes with Node.js 15 or newer. To simplify installation of proper versions you can make use of nvm and run nvm install – it will activate proper Node.js version in your current command prompt session.

Contribution Workflow

  1. Click Fork above. It will automatically create a copy of this repository and add it to your account.
  2. Clone the repository to your computer.
  3. Open the folder in command prompt and run npm install
  4. Make any changes you would like to suggest.
  5. In command prompt run npm run build which will compile it to the /build folder, where you can make sure it works – the easiest way to do so is to run npm run serve. You can also do both at once by running npm test.
  6. Add, Commit and Push your changes to your fork.
  7. On the github page for your fork, click New Pull Request above the file list.
  8. Change the head repository dropdown to your fork.
  9. Add a title and description explaining your changes.
  10. Click create pull request.

If you have any trouble, see this page: https://help.github.com/en/articles/creating-a-pull-request-from-a-fork

License

This software may not be resold, redistributed, rehosted or otherwise conveyed to a third party.