Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 2.34 KB

README.md

File metadata and controls

58 lines (40 loc) · 2.34 KB

checks build tests codecov

NOTE: this project is a work in progress, if you want to use it, please save your work as frequently as possible to avoid losing it.

alt text

Tarsila is a pixel art and spritesheet editor written in Rust with macroquad as graphics backend and egui for GUI. The project consists of 2 crates:

  • tarsila: the frontend GUI of the editor;
  • lapix: the backend/core of the editor, where all interesting things happen.

To learn more about the architecture take a look at ARCHITECTURE.md.

To contribute, take a look at CONTRIBUTING.md.

Getting Started

Check out our installation instructions.

To learn how to use, take a look at the user guide.

Known Issues

Have in mind that this project is a work in progress and might have a lot of bugs, incomplete or missing features and suboptimal performance here and there. Some of the main gaps currently are:

  • Works as intended on Linux, but there are some compatibility issues with MacOS (file dialog window does not open, modifier keys do not work); Windows is reported to be working as intended;
  • There are a few unit tests, but integration tests are missing, and coverage is far from 100%;
  • There is room to improve when it comes to performance

Visit our issues page for known problems/bugs.

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.