diff --git a/src/docs/format.md b/src/docs/format.md new file mode 100644 index 0000000..c900a1e --- /dev/null +++ b/src/docs/format.md @@ -0,0 +1,21 @@ +# File/Folder Name Format Placeholders +## File +* `{date}` - 20240509 (yyyyMMdd) +* `{time}` - 092645 (HHmmss) +* `{roundShort}` - WSF +* `{roundLong}` - Winners Semi-Finals +* `{playersOnly}` - Player 1, Player 2 +* `{playersChars}` - Player 1 (Marth), Player 2 (Fox) +* `{singlesChars}` - `{playersChars}` if singles, `{playersOnly}` if doubles +* `{stage}` - Battlefield +* `{ordinal}` - 1 (game 1, game 2, game 3, etc) + +## Folder +* `{date}` - 20240509 (yyyyMMdd) +* `{time}` - 0926 (HHmm) +* `{roundShort}` - WSF +* `{roundLong}` - Winners Semi-Finals +* `{playersOnly}` - Player 1, Player 2 +* `{playersChars}` - Player 1 (Marth), Player 2 (Fox, Falco) +* `{singlesChars}` - `{playersChars}` if singles, `{playersOnly}` if doubles +* `{games}` - 3 (number of games) diff --git a/src/renderer/Settings.tsx b/src/renderer/Settings.tsx index c9c753a..6f398e9 100644 --- a/src/renderer/Settings.tsx +++ b/src/renderer/Settings.tsx @@ -237,6 +237,17 @@ export default function Settings({ setUseEnforcer(checked); }} /> + + File/Folder name format placeholders documented{' '} + + here + + . +