https://github.com/cloudhead/rx

👾 Modern and minimalist pixel editor
https://github.com/cloudhead/rx

8bit gamedev graphics pixel pixel-art pixel-art-editor retro rust

Last synced: about 8 hours ago
JSON representation

👾 Modern and minimalist pixel editor

• Host: GitHub
• URL: https://github.com/cloudhead/rx
• Owner: cloudhead
• License: gpl-3.0
• Created: 2019-08-14T21:54:49.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-31T21:57:35.000Z (11 months ago)
• Last Synced: 2024-10-29T15:34:15.947Z (about 1 month ago)
• Topics: 8bit, gamedev, graphics, pixel, pixel-art, pixel-art-editor, retro, rust
• Language: Rust
• Homepage: https://discord.gg/xHggPjfsS9
• Size: 3.51 MB
• Stars: 3,125
• Watchers: 24
• Forks: 109
• Open Issues: 37
• Metadata Files:
  • Readme: README
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING
  • License: LICENSE

Awesome Lists containing this project

• awesome-rust - rx
• awesome-rust-cn - rx
• awesome-list - rx
• awesome-rust - rx - Vi inspired Modern Pixel Art Editor (Applications)
• fucking-awesome-rust - rx - Vi inspired Modern Pixel Art Editor (Applications)
• fucking-awesome-rust - rx - Vi inspired Modern Pixel Art Editor (Applications)

README

        


        ██ ████ ██ ██

         ███ ██  ███

         ██     ██ ██

         ██    ██   ██

    `rx` is a modern and minimalist pixel editor.

  Designed with great care and love

    with pixel artists and animators in mind.

OVERVIEW

  `rx` is an extensible, modern and minimalist pixel editor implemented

  in rust[0]. rx is free software, licensed under the GPLv3.

  Most of the information on how to use rx is on the website:

  https://rx.cloudhead.io. There, you can also find a user guide

  (https://rx.cloudhead.io/guide.html), installation instructions,

  and binary download links.

  For discussions, join the community: https://rx.cloudhead.io/#community.

  To build rx from source, see the build sections below.

  Once inside rx, enter the `:help` command to get a list of key bindings

  and commands.

  [0]: https://rust-lang.org

REQUIREMENTS

  At a minimum, OpenGL 3.3 support is required.

BUILD DEPENDENCIES

  * rust (https://www.rust-lang.org/tools/install)

  * cmake (https://cmake.org/download/)

  On macOS, `Xcode` and the `Xcode Command Line Tools` are required.

  The latter can be obtained by running `xcode-select --install`

  CMake can be installed with `brew install cmake`.

BUILD & INSTALLATION

  Before proceeding, make sure the BUILD DEPENDENCIES have been installed.

  Then, clone this repository and from its root, run:

    $ cargo install --locked --path .

  This will install rx under `~/.cargo/bin/rx`.  If you prefer a different

  install location, you can specify it via the `--root ` flag, where

   is for example '/usr/local'.

CONTRIBUTING

  See the CONTRIBUTING file for details. Contributions are appreciated.

USAGE

  See the guide at https://rx.cloudhead.io/guide.html.

TROUBLESHOOTING

  If something isn't working like it's supposed to, there are various things

  you can do to debug the problem:

  * Run `rx` with verbose logging, by using the `-v` command-line flag. This

    will log errors from the underlying libraries that are usually suppressed,

    and will show debug output that might indicate what the problem is.

  * If `rx` is crashing, run it with `RUST_BACKTRACE=1` set in your environment

    to show a backtrace on crash.

  * It could be that the issue is related to your configuration - in that case

    the program can be run without loading the initialization script like so:

        rx -u -

LICENSE

  This software is licensed under the GPL. See the LICENSE file for more details.

COPYRIGHT

  (c) 2019 Alexis Sellier