reorganize api doc

This commit is contained in:
2025-02-08 20:50:25 -06:00
parent 4361ad9daa
commit 95c64f51de
35 changed files with 513 additions and 305 deletions

View File

@@ -0,0 +1 @@
# packer

View File

@@ -0,0 +1,52 @@
# resources
## canonical(file)
## find_image(...args)
## find_sound(...args)
## find_script(...args)
## find_font(...args)
## getAllFiles(dir)
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)
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)
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.
**dir**: The directory to zip.
**outPath**: The path (including filename) for the resulting ZIP file.
**Returns**: None
:raises Error: If the directory does not exist.

View File

@@ -1,11 +0,0 @@
# resources
## canonical(file)
## find_image(...args)
## find_sound(...args)
## find_script(...args)
## find_font(...args)

View File

@@ -1,4 +1,6 @@
# Preface: The Prosperon Manifesto
# Preface: The Prosperon Vision
![image](wizard.png)
Prosperon is based around a Javascript-like language, named "dull", engineered to be the quickest way to make computer games.
@@ -19,7 +21,6 @@ Uniformity is prioritized. Javascript allows for a powerful abstraction - the ob
!!! scholium
The object is the lingua franca of the API. For example, json.encode and json.decode converts objects to and from json strings; nota.encode and nota.decode converts objects to and from nota bytes, represented as a javascript arraybuffer. To convert a json string to a nota buffer, one would do:
```nota.encode(json.decode(str))```
4. **AI**
Prosperon is packed with tools to make it easy to work with AI. AI is an incredible productivity boost for programming, but it has a difficult time dealing with game engines like Unity and Unreal. Prosperon can, for example, generate an overview of your game, which you can plug into an AI for context so it will have an easy time helping with what you're stuck on.

BIN
docs/wizard.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 MiB