docs

docs/api/modules/resources.md

@@ -0,0 +1,68 @@
+# resources
+
+### scripts <sub>object</sub>
+
+### images <sub>object</sub>
+
+### sounds <sub>object</sub>
+
+### fonts <sub>object</sub>
+
+### lib <sub>object</sub>
+
+### canonical(file) <sub>function</sub>
+
+### find_image(...args) <sub>function</sub>
+
+### find_sound(...args) <sub>function</sub>
+
+### find_script(...args) <sub>function</sub>
+
+### find_font(...args) <sub>function</sub>
+
+### getAllFiles(dir) <sub>function</sub>
+
+
+Return a list of recognized files in the given directory that are not matched by
+.prosperonignore, skipping directories. Recognized extensions include scripts,
+images, sounds, fonts, and libs.
+
+
+
+**dir**: The directory to search.
+
+
+**Returns**: An array of recognized file paths.
+
+
+### gatherStats(filePaths) <sub>function</sub>
+
+
+Analyze a list of recognized files and categorize them by scripts, images, sounds,
+fonts, libs, or other. Return a stats object with these counts and the total.
+
+
+
+**filePaths**: An array of file paths to analyze.
+
+
+**Returns**: { scripts, images, sounds, fonts, lib, other, total }
+
+
+### pack(dir, outPath) <sub>function</sub>
+
+
+Create a ZIP archive of all recognized files (skipping those matched by .prosperonignore)
+in the specified directory and write it to outPath. Recognized extensions are scripts,
+images, sounds, fonts, or libs.
+
+:raises Error: If the directory does not exist.
+
+
+**dir**: The directory to zip.
+
+**outPath**: The path (including filename) for the resulting ZIP file.
+
+
+**Returns**: None
+