Skip to content

Commit dca4b66

Browse files
committed
2 parents 5ffeded + 8e67fe3 commit dca4b66

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,41 @@
1+
<img align="left" width="100" height="100" src="https://i.imgur.com/IlTprgN.png">
2+
13
# PopSpriteEditor
24
Open source Sprite Viewer &amp; Editor tool written in C++/CLI for the game **Populous: The Beginning**.
35

6+
<p align="center">
7+
<img width="800" height="600" src="https://i.imgur.com/XMEdjnT.png"></img>
8+
</p>
9+
410
### Features
5-
- Open banks:
11+
- **Open banks**:
612
- Preview scaled sprites (slider) with nearest-neighbor interpolation.
713
- Export sprites as bitmaps (individually or in bulk).
814
- View offset, index, width, height and raw data of each sprite.
9-
- Create banks:
15+
- **Create banks**:
1016
- From bitmaps of any width & height.
1117
- Append or insert to an "existing" bank.
1218
- Modify original sprites width & height.
13-
- Color Palette:
19+
- **Color Palette**:
1420
- Preview color palette.
1521
- Adjustable color key.
16-
- Pixel Inspector; hover over an image and a tooltip will appear showing the highlighted pixel's values:
22+
- Export to bitmap format.
23+
- **Pixel Inspector**; hover over an image and a tooltip will appear showing the highlighted pixel's values:
1724
- Position (current width & height).
1825
- RGB values.
1926
- Index in the color palette.
2027
- Right click to copy RGB values.
21-
- Basic editing functionality:
28+
- **Sprite Editor**:
2229
- 2 color slots (right/left click).
2330
- Brush mode; paint individual pixels (r/l click).
2431
- Color pick mode; copy RGB values from highlighted pixel (r/l click).
2532
- ``CTRL + Z`` (undo).
2633
- ``CTRL + Y`` (redo).
2734
- Key ``B`` (brush mode).
2835
- Key ``Y`` (color pick mode).
29-
- Export color palette to bitmap format (``File`` -> ``Export Palette``).
36+
- **Sprite Sheet Manager**:
37+
- Generate sheets from frames.
38+
- Parse & Split sheets to individual frames.
3039

3140
### Usage
3241
Usage is straight forward. The numbering (names) of the bitmaps is the order they'll be saved in, and any gaps in the numbering isn't a problem as the editor will renumber the files internally. Files that aren't bitmaps or bitmaps with letters in the name will be ignored.
@@ -39,6 +48,16 @@ Usage is straight forward. The numbering (names) of the bitmaps is the order the
3948
7. Create a new bank from these bitmaps `File` -> `Create Sprite Bank` -> `From Images`.
4049
8. Replace the original game's sprite bank with the newly created one.
4150

51+
### Sprite Sheets
52+
A valid sprite sheet has to abide by the following rules:
53+
* Sprites can't touch corners or edges; ensure there's a space between of at least 1 pixel.
54+
* New rows have to be separated by a pink continuous line.
55+
* Background color has to be cyan. (RGB: 0, 255, 255)
56+
* Color key color has to be pink. (RGB: 255, 0, 255)
57+
58+
An example of a valid sprite sheet:
59+
![valid sprite sheet](https://i.imgur.com/TAhdfqI.png)
60+
4261
### Credits
4362
[EasyBMP Library](http://easybmp.sourceforge.net/about.html)
4463

0 commit comments

Comments
 (0)