Skip to content

Commit 1d1d8ba

Browse files
committed
docs?
1 parent 7d0fb55 commit 1d1d8ba

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Flex 2 is a multi-purpose art and mapping editor for the Sega Megadrive. The ori
88

99
Much inspiration has come from the tools SonMapEd, SpritePlotter, and SonikSprite - with ideas being combined and improved upon.
1010

11-
There is a fair amount of hidden behaviour in this application, reading this document is highly recommended before use.
11+
Because of hidden behaviour in this application, reading this document is recommended before use.
1212

1313

1414
## Controls
@@ -23,6 +23,11 @@ You can cycle through options in dropdown boxes and increase/decrease numbers in
2323

2424
The UI layout is fully customisable by moving or resizing tabs.
2525

26+
## Project Files
27+
28+
Project files serve as definitions for all the objects in your project. They should sit at the root of your project directory and be committed to version control. This allows quick saving and loading of data.
29+
30+
A key change from version 1 is that Flex no longer has a game mode. Data is saved and loaded as whatever the definition for the object says. This means you can mix formats (like S1 Mappings and S2 DPLCs for editing Sonic CD data), or even provide custom definitions.
2631

2732
## Mapping Editor
2833

@@ -54,13 +59,17 @@ Palette input will be normalised into Megadrive colours. To change the order of
5459

5560
## Sprites
5661

62+
The Sprites tab gives an overview of your full object's data, allowing you to change sprites or reorder them by dragging and dropping.
63+
5764
## Importing
5865

59-
## Project Files
66+
When importing an image over the current frame this is no limitation on image dimensions.
67+
68+
For importing a spritesheet, either the alpha channel or the top left pixel color will serve as transparency.
6069

61-
## DPLC Optimization
70+
Mapping output can be configured to either reduce the number of tiles, or the number of mappings. The algorithm favours fewer horizontal sprites over vertical ones.
6271

63-
## Mapping Formats
72+
Both methods of importing use CIEDE2000 nearest colour matching to the current palette.
6473

6574
## Download
6675

0 commit comments

Comments
 (0)