Skip to content

Commit

Permalink
Update README and create Roadmap.md
Browse files Browse the repository at this point in the history
  • Loading branch information
patataofcourse committed Jun 28, 2021
1 parent dab89e5 commit 79c0836
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
+ Currently, the PNG's color mode must be set to indexed. This will be changed in future versions.
+ The image must have at most 256 different colors. This is a limitation of the format.
* Extracting the contents of a PCM file into a folder, and building a PCM file from the contents of a folder.
* Replacing certain files inside a PCM file.

For a full roadmap of the features that will be added to Flora in the near future, check out [Roadmap.md](Roadmap.md)

### Usage
Flora is a CLI tool, which means that it must be ran from a command line (cmd/bash).<br>
Expand Down
16 changes: 16 additions & 0 deletions Roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Flora roadmap
- [x] 0.1
- Pack and unpack GDS files
- [x] 0.2
- Extract BG files to PNG and create BG files from indexed PNGs
- [x] 0.3
- Extract the contents of a PCM file into a folder and make a PCM file from the contents of a folder
- [ ] 0.4
- Replace files inside a PCM file with those given in a folder
- Extract and import files specific to a certain puzzle, for ease of puzzle editing
- [ ] 0.4.1
- Make classes for BG and GDS files, so that they can be used in other commands
- [ ] 0.5
- Flora mod files: Create and load mods based on the files that they edit, so that multiple mods can be loaded at the same time if they are compatible.
- [ ] 1.0
- Extract all data related to a puzzle to formats such as JSON, PNG, etc. for ease of editing, and later on load as a Flora mod. Includes simplifying the script into a format that can easily be understood.

0 comments on commit 79c0836

Please sign in to comment.