Skip to content

Commit

Permalink
Added a section on color replace shading, also revised old pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Variable-ind committed Nov 10, 2024
1 parent 3c28223 commit fea0e23
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ However, the [Steam version](https://store.steampowered.com/app/2779170/Pixelora

## Q: What platforms is Pixelorama available on?
A: Pixelorama is currently available for Windows, Linux, Mac and Web browsers. More platforms may be supported in the future.
You can download Pixelorama from [itch.io](https://orama-interactive.itch.io/pixelorama), [GitHub releases](https://github.com/Orama-Interactive/Pixelorama/releases) and very soon on [Steam](https://store.steampowered.com/app/2779170/Pixelorama/). It is also available on Scoop for Windows, as a [Flatpak](https://flathub.org/apps/details/com.orama_interactive.Pixelorama) and [Snap](https://snapcraft.io/pixelorama) for Linux.
You can download Pixelorama from [itch.io](https://orama-interactive.itch.io/pixelorama), [GitHub releases](https://github.com/Orama-Interactive/Pixelorama/releases) and on [Steam](https://store.steampowered.com/app/2779170/Pixelorama/). It is also available on Scoop for Windows, as a [Flatpak](https://flathub.org/apps/details/com.orama_interactive.Pixelorama) and [Snap](https://snapcraft.io/pixelorama) for Linux.

## Q: What benefits does the Steam version provide?
A: Users who buy Pixelorama through Steam will enjoy the benefits that Steam provides to all of the games and software hosted there, such as automatic updates and Steam Achievements. It is also a great way to fund the project's development! Apart from that, there will be no other difference between the non-Steam version. All of Pixelorama's features will be the same in all versions, and all versions will receive the same updates. In other words, the Steam version will not be a "Pro" version. It will be exactly the same as the non-Steam version, just with the added benefits that come naturally from Steam.
A: Users who buy Pixelorama through Steam will enjoy the benefits that Steam provides to all of the games and software hosted there, such as automatic updates and Steam Achievements. It is also a great way to fund the project's development! Apart from that, there will be no other difference between the non-Steam version. All of Pixelorama's features will be the same in all versions, and all versions will receive the same updates. In other words, the Steam version will **not** be a "Pro" version. It will be exactly the same as the non-Steam version, just with the added benefits that come naturally from Steam.

## Q: Who is working on Pixelorama?
A: Pixelorama is being developed by [Orama Interactive](https://www.oramainteractive.com/), a game development team. Of course, Pixelorama would not be the same without the help of our beloved [contributors](https://github.com/Orama-Interactive/Pixelorama/graphs/contributors)!
Expand All @@ -36,7 +36,7 @@ Yes! Read our [Ways to Contribute](development_and_contributing) page to learn m
A: Pixelorama was originally created as a stand-alone program. Our current focus is to keep improving it and not implementing it into Godot itself, but we are not declining the possibility of it being a plugin one day. However, if you are interested in direct Pixelorama support from Godot, you can use this amazing [Godot Pixelorama importer plugin](https://github.com/Technohacker/godot_pixelorama_importer) which can be used to make Godot import pxo files.

## Q: What languages is Pixelorama available in?
A: The main language is English, but Pixelorama is also available in numerous other languages! [All of our translation files are hosted in Crowdin](https://crowdin.com/project/pixelorama). By default, the language that Pixelorama is in is the system language of your device. You can easily change it by going to the Edit menu, Preferences, Language.
A: The main language is English, but Pixelorama is also available in numerous other languages! [All of our translation files are hosted in Crowdin](https://crowdin.com/project/pixelorama). By default, the language that Pixelorama is in is the system language of your device. You can easily change it by going to the `Edit menu > Preferences > Language`.

## Q: What are the minimum system requirements to run Pixelorama?
A: Pixelorama is a relatively lightweight software and it should run on most devices, as long as OpenGL 3.3 / OpenGL ES 3.0 is supported.
Expand Down
13 changes: 6 additions & 7 deletions docs/user_manual/palettes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 5

Palettes are a way to organize colors in your projects.

Pixelorama ships on most platforms with several pre-made palettes. These palettes can be freely modified.
Pixelorama ships on most platforms with two pre-made palettes (`Default` and `Pixelorama`). These palettes can be freely modified.

All palettes are physically stored on disk in Pixelorama data folder.

Expand All @@ -18,12 +18,10 @@ Palettes currently don't support undo/redo so be careful with any modifications
## Palettes panel
![Pixelorama's Canvas](../../static/img/palettes-panel.png)

The top of the panel consists of `Palettes selector`, [`Edit palette button`](#editing-palette-metadata) and [`Add new palette button`](#creating-new-palette).
The top of the panel consists of [`tools`](#palette-grid-tools) (used to edit colors of the palette), `Palettes selector`, [`Edit palette button`](#editing-palette-metadata) and [`Add new palette button`](#creating-new-palette).

The main section is the [`Palette grid`](#palette-grid), displaying all colors present in the currently selected palette.

On the left of the [`Palette grid`](#palette-grid) are [`tools`](#palette-grid-tools) used to edit the colors of the palette.

### Creating a new palette {#creating-new-palette}
![Pixelorama's Canvas](../../static/img/palette-create.png)

Expand Down Expand Up @@ -102,15 +100,16 @@ Tools allow you to edit colors in the palette.
| ----- | ---- | ----------- |
| `+` | Add a new color | Left mouse click adds left tool color. Right mouse click adds right tool color. |
| `-` | Remove a selected color | Left mouse click removes left selected color. Right mouse click removes right selected color. |
| `` | Palette sorting options| A drop-down appears, containing the available sorting options. You can either apply the new color order directly to palette or to a copy of it. |

### Colors movement
Colors can be moved and copied around in the palette grid.

| Shortcut | Movement description |
| -------- | -------- |
| -------- | -------- |
| `Mouse drag` | Color switches with a color it is dropped on. |
| <kbd>Shift</kbd> + `Mouse drag` | Color is inserted where dropped. If dropped on another color the original color is moved to the right with every color next to it. |
| <kbd>Ctrl</kbd> + `Mouse drag` | Color is copied where dropped. If dropped on another color the original color is overwritten. |
| <kbd>Shift</kbd> + `Mouse drag` | Color is inserted where dropped. If dropped on another color the original color is moved to the right with every color next to it. |
| <kbd>Ctrl</kbd> + `Mouse drag` | Color is copied where dropped. If dropped on another color the original color is overwritten. |

## Palettes import
To import a palette, either `drag and drop` a palette file into Pixelorama window or use `File > Open` dialog.
Expand Down
6 changes: 6 additions & 0 deletions docs/user_manual/shading.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,9 @@ Here is a video by Brandon James Greer that explains the concept of hue shifting
:::caution hue shifting limits
The hue shifting mode does not always change the hue, saturation and value of the colors exactly as much as the values have been set by the user. For example, a color with a hue of 70 and the shading tool set to hue shifting, lighten and a hue of, let's say, 20, will not result in a color with a hue of 50 (because 70 - 20 = 50), but it will rather stay limited to 60, as this is the hard limit of lighting. Similarly, the hard hue limit of darkening is 240. If you want to exactly change the HSV values of a color, you can use the `Adjust Hue/Saturation/Value` image effect under the Image menu.
:::

## Color Replace
This mode is pretty much self explainatory. The user selects an array of colors by first selecting a color on the palette and then specifying the number of colors to pick after it through the `Colors right` slider. When shading, if a color is present in the chosen array of colors, it then gets replaced by the next (or previous) color in the array, depending on your current lighten/darken mode.

![Color replace mode properties](../../static/img/shading_cr.png)
##### Properties of the Color replace shading mode.
Binary file modified static/img/palettes-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/shading_cr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fea0e23

Please sign in to comment.