format name placeholder doc

#28
jmlee337 · May 9, 2024 · 91d45a5 · 91d45a5
1 parent 80bf2e9
commit 91d45a5
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/src/docs/format.md 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
@@ -237,6 +237,17 @@ export default function Settings({
                 setUseEnforcer(checked);
               }}
             />
+            <DialogContentText>
+              File/Folder name format placeholders documented{' '}
+              <a
+                href="https://github.com/jmlee337/replay-manager-for-slippi/blob/main/src/docs/format.md"
+                target="_blank"
+                rel="noreferrer"
+              >
+                here
+              </a>
+              .
+            </DialogContentText>
             <Stack alignItems="end" direction="row" gap="8px">
               <TextField
                 fullWidth