Merge branch 'master' of https://github.com/Toksisitee/PopSpriteEditor

README.md

@@ -0,0 +1,33 @@
+# PopSpriteEditor
+Open source Sprite Viewer & Editor tool written in C++/CLI for the game **Populous: The Beginning**.
+
+### Features
+- Open banks:
+  - Preview scaled sprites (slider) with nearest-neighbor interpolation.
+  - Export sprites as bitmaps (individually or in bulk).
+  - View offset, index, width, height and raw data of each sprite.
+- Create banks:
+  - From bitmaps of any width & height.
+  - Append or insert to an "existing" bank.
+  - Modify original sprites width & height.
+- Color Palette:
+  - Preview color palette.
+  - Adjustable color key.
+
+### Usage
+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.
+1. Download the latest release from [here](https://github.com/Toksisitee/PopSpriteEditor/releases).
+2. Ensure `pal.dat` is located in the same folder as the software.
+3. Open a valid bank `File` -> `Open` from the game's `data` folder.
+4. Export all sprites within the bank `File` -> `Export Sprites`.
+5. Open the newly created folder `output` (editor folder), it should contain all saved sprites.
+6. Modify (resolution and/or colors), delete or add new bitmaps.
+7. Create a new bank from these bitmaps `File` -> `Create Sprite Bank` -> `From Images`.
+8. Replace the original game's sprite bank with the newly created one.
+
+### Credits
+[C++ Bitmap Library](https://github.com/ArashPartow/bitmap) by Arash Partow
+
+### License
+PopSpriteEditor Copyright © 2020 Toksisitee.  
+This program is distributed under the GNU GPLv3 license. See the LICENSE file for more details.