From 736162dd7d13bd5b1412d16acbaf438d1170c09a Mon Sep 17 00:00:00 2001
From: "dev-docs-github-app[bot]"
 <178952281+dev-docs-github-app[bot]@users.noreply.github.com>
Date: Tue, 27 May 2025 17:20:12 +0000
Subject: [PATCH 1/2] Update 4 files

---
 docs/api/generateNinja.md    | 80 ++++++++++++++++++++++++++++++++++++
 docs/api/generateRobot.md    | 76 ++++++++++++++++++++++++++++++++++
 docs/api/generateSpaceman.md | 76 ++++++++++++++++++++++++++++++++++
 docs/getting-started.md      | 26 ++++++++++++
 4 files changed, 258 insertions(+)
 create mode 100644 docs/api/generateNinja.md
 create mode 100644 docs/api/generateRobot.md
 create mode 100644 docs/api/generateSpaceman.md

diff --git a/docs/api/generateNinja.md b/docs/api/generateNinja.md
new file mode 100644
index 00000000..cc872c83
--- /dev/null
+++ b/docs/api/generateNinja.md
@@ -0,0 +1,80 @@
+# generateNinja
+
+`generateNinja` is a convenience function provided by the SpriteAI library to generate a ninja character spritesheet with predefined animation states.
+
+## Overview
+
+The `generateNinja` function creates a pixel-art style spritesheet for a ninja character with black outfit and mask. It utilizes the more general `generateCharacterSpritesheet` function with preset options tailored for a ninja character.
+
+## Syntax
+
+```javascript
+export const generateNinja = async function(options = {}) {
+  // ... implementation details
+}
+```
+
+## Parameters
+
+- `options` (optional): An object containing custom options to override the default settings.
+
+### Default Options
+
+```javascript
+{
+  states: ['idle', 'walk', 'run', 'attack', 'sneak'],
+  style: 'pixel-art',
+  framesPerState: 6
+}
+```
+
+## Return Value
+
+The function returns a Promise that resolves to an object containing:
+
+- `original`: URL of the original generated image
+- `spritesheet`: Base64-encoded string of the processed spritesheet
+- `metadata`: Object containing information about the generated spritesheet
+
+## Usage Example
+
+```javascript
+import { generateNinja } from 'spriteAI';
+
+async function createNinjaSprite() {
+  try {
+    const ninjaSprite = await generateNinja();
+    console.log('Ninja sprite generated:', ninjaSprite);
+    // Use the generated sprite in your game or application
+  } catch (error) {
+    console.error('Error generating ninja sprite:', error);
+  }
+}
+
+createNinjaSprite();
+```
+
+## Customization
+
+You can customize the ninja sprite generation by passing options:
+
+```javascript
+const customNinja = await generateNinja({
+  framesPerState: 8,
+  style: 'hand-drawn'
+});
+```
+
+This will generate a ninja sprite with 8 frames per animation state in a hand-drawn style instead of pixel-art.
+
+## Notes
+
+- The function uses AI-powered image generation, so results may vary slightly between calls.
+- The generated spritesheet is optimized for game development use, with clear separation between animation states.
+- For more control over the sprite generation process, consider using the `generateCharacterSpritesheet` function directly.
+
+## See Also
+
+- [generateCharacterSpritesheet](./generateCharacterSpritesheet.md)
+- [generateSpaceman](./generateSpaceman.md)
+- [generateRobot](./generateRobot.md)
\ No newline at end of file
diff --git a/docs/api/generateRobot.md b/docs/api/generateRobot.md
new file mode 100644
index 00000000..0b841e71
--- /dev/null
+++ b/docs/api/generateRobot.md
@@ -0,0 +1,76 @@
+# generateRobot
+
+## Overview
+
+The `generateRobot` function is a convenience method for generating a robot character spritesheet using the SpriteAI library. This function streamlines the process of creating a pixel art robot character with predefined animation states.
+
+## Syntax
+
+```javascript
+generateRobot(options = {})
+```
+
+## Parameters
+
+- `options` (optional): An object containing configuration options for the robot sprite generation.
+  - `states` (array of strings): Animation states for the robot. Default: `['idle', 'walk', 'run', 'attack', 'power-up']`
+  - `style` (string): The art style for the sprite. Default: `'pixel-art'`
+  - `framesPerState` (number): Number of frames for each animation state. Default: `6`
+
+## Returns
+
+- A Promise that resolves to an object containing:
+  - `original`: URL of the original generated image
+  - `spritesheet`: Base64-encoded PNG data of the processed spritesheet
+  - `metadata`: Object containing information about the generated spritesheet
+
+## Description
+
+The `generateRobot` function is built on top of the `generateCharacterSpritesheet` function, providing a simplified interface for creating robot character sprites. It uses predefined settings tailored for robot characters, including specific animation states and a default description.
+
+By default, the function generates a pixel art robot character with mechanical limbs and glowing eyes. The spritesheet includes five animation states: idle, walk, run, attack, and power-up.
+
+## Example Usage
+
+```javascript
+import { generateRobot } from 'spriteAI';
+
+async function createRobotSprite() {
+  try {
+    const robotSprite = await generateRobot({
+      framesPerState: 8,
+      style: 'pixel-art'
+    });
+    console.log('Robot sprite generated:', robotSprite);
+    // Use the robotSprite.spritesheet data in your game or application
+  } catch (error) {
+    console.error('Error generating robot sprite:', error);
+  }
+}
+
+createRobotSprite();
+```
+
+## Customization
+
+You can customize the robot sprite generation by passing options to the `generateRobot` function. For example, you can change the number of frames per state or add additional animation states:
+
+```javascript
+const customRobot = await generateRobot({
+  states: ['idle', 'walk', 'run', 'attack', 'power-up', 'shutdown'],
+  framesPerState: 4,
+  style: 'vector'
+});
+```
+
+## Notes
+
+- The function uses AI-powered image generation, so results may vary slightly between calls.
+- The generated spritesheet is optimized for game development and can be easily integrated into game engines or frameworks that support spritesheets.
+- For more complex customizations, consider using the `generateCharacterSpritesheet` function directly.
+
+## See Also
+
+- [generateCharacterSpritesheet](./generateCharacterSpritesheet.md)
+- [generateNinja](./generateNinja.md)
+- [generateSpaceman](./generateSpaceman.md)
\ No newline at end of file
diff --git a/docs/api/generateSpaceman.md b/docs/api/generateSpaceman.md
new file mode 100644
index 00000000..332531d1
--- /dev/null
+++ b/docs/api/generateSpaceman.md
@@ -0,0 +1,76 @@
+# generateSpaceman
+
+## Overview
+
+The `generateSpaceman` function is a convenience method for generating a sprite sheet of an astronaut character. This function is part of the SpriteAI library and utilizes the more general `generateCharacterSpritesheet` function with pre-configured options suitable for a spaceman character.
+
+## Syntax
+
+```javascript
+export const generateSpaceman = async function(options = {}) {
+  // Function implementation
+}
+```
+
+## Parameters
+
+- `options` (optional): An object containing configuration options to customize the sprite generation. If not provided, default values will be used.
+
+### Default Options
+
+```javascript
+{
+  states: ['idle', 'walk', 'run', 'float'],
+  style: 'pixel-art',
+  framesPerState: 6
+}
+```
+
+## Return Value
+
+The function returns a Promise that resolves to an object containing:
+
+- `original`: The URL of the original generated image.
+- `spritesheet`: A base64-encoded string of the processed sprite sheet.
+- `metadata`: An object containing information about the generated sprite sheet.
+
+## Usage
+
+```javascript
+import { generateSpaceman } from 'spriteAI';
+
+// Generate a spaceman sprite with default options
+const result = await generateSpaceman();
+
+// Generate a spaceman sprite with custom options
+const customResult = await generateSpaceman({
+  states: ['idle', 'walk', 'run', 'float', 'jump'],
+  framesPerState: 8
+});
+```
+
+## Description
+
+The `generateSpaceman` function creates a pixel-art style sprite sheet of an astronaut character. By default, it includes four animation states: idle, walk, run, and float. Each state is represented by 6 frames in the resulting sprite sheet.
+
+Internally, this function calls `generateCharacterSpritesheet` with a pre-defined description: "astronaut character with space suit and helmet". This ensures consistency in the generated spaceman character across different calls.
+
+## Customization
+
+While the function comes with default options, you can customize various aspects of the sprite generation by passing an `options` object. This allows you to:
+
+- Add or remove animation states
+- Change the number of frames per state
+- Alter the art style (though 'pixel-art' is recommended for consistency)
+
+## Notes
+
+- The generated sprite sheet is optimized for use in 2D games or applications requiring animated astronaut characters.
+- The 'float' state is unique to the spaceman character, simulating low-gravity or zero-gravity movement.
+- For more control over the sprite generation process, consider using the `generateCharacterSpritesheet` function directly.
+
+## See Also
+
+- [generateCharacterSpritesheet](./generateCharacterSpritesheet.md)
+- [generateNinja](./generateNinja.md)
+- [generateRobot](./generateRobot.md)
\ No newline at end of file
diff --git a/docs/getting-started.md b/docs/getting-started.md
index bb03851d..6692d021 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -55,6 +55,32 @@ SpriteAI offers a range of powerful features to enhance your sprite creation and
 1. **Sprite Generation**: Utilise `generateSprite(name, width, height)` to programmatically create new sprites.
 2. **Sprite Loading**: Easily load existing sprites with `loadSprite(path)`.
 3. **Sprite Saving**: Preserve your sprites using `saveSprite(sprite, path)`.
+4. **Character Spritesheet Generation**: Create detailed character spritesheets with `generateCharacterSpritesheet(description, options)`.
+5. **Environment Sprite Generation**: Generate environment sprites with `generateEnvironmentSprites(description, options)`.
+6. **Item Sprite Generation**: Create item sprites for your game with `generateItemSprites(description, options)`.
+
+## New Convenience Functions
+
+SpriteAI now includes convenient functions for generating specific character types:
+
+```javascript
+// Generate a ninja character
+spriteAI.generateNinja(options)
+  .then(result => console.log(result))
+  .catch(error => console.error(error));
+
+// Generate a spaceman character
+spriteAI.generateSpaceman(options)
+  .then(result => console.log(result))
+  .catch(error => console.error(error));
+
+// Generate a robot character
+spriteAI.generateRobot(options)
+  .then(result => console.log(result))
+  .catch(error => console.error(error));
+```
+
+These functions come with preset options tailored for each character type, but you can customize them as needed.
 
 ## Advanced Techniques
 

From 91d091ad841ba4d1f0bb7f2a521201973b022692 Mon Sep 17 00:00:00 2001
From: "dev-docs-github-app[bot]"
 <178952281+dev-docs-github-app[bot]@users.noreply.github.com>
Date: Fri, 13 Jun 2025 17:55:31 +0000
Subject: [PATCH 2/2] Update 3 files

---
 docs/api/generateNinja.md    | 3 ++-
 docs/api/generateRobot.md    | 2 +-
 docs/api/generateSpaceman.md | 2 +-
 3 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/api/generateNinja.md b/docs/api/generateNinja.md
index cc872c83..4c641377 100644
--- a/docs/api/generateNinja.md
+++ b/docs/api/generateNinja.md
@@ -71,10 +71,11 @@ This will generate a ninja sprite with 8 frames per animation state in a hand-dr
 
 - The function uses AI-powered image generation, so results may vary slightly between calls.
 - The generated spritesheet is optimized for game development use, with clear separation between animation states.
+- The 'sneak' state is included in the default options, which is unique to the ninja character.
 - For more control over the sprite generation process, consider using the `generateCharacterSpritesheet` function directly.
 
 ## See Also
 
 - [generateCharacterSpritesheet](./generateCharacterSpritesheet.md)
 - [generateSpaceman](./generateSpaceman.md)
-- [generateRobot](./generateRobot.md)
\ No newline at end of file
+- [generateRobot](./generateRobot.md)
diff --git a/docs/api/generateRobot.md b/docs/api/generateRobot.md
index 0b841e71..39cc83fb 100644
--- a/docs/api/generateRobot.md
+++ b/docs/api/generateRobot.md
@@ -73,4 +73,4 @@ const customRobot = await generateRobot({
 
 - [generateCharacterSpritesheet](./generateCharacterSpritesheet.md)
 - [generateNinja](./generateNinja.md)
-- [generateSpaceman](./generateSpaceman.md)
\ No newline at end of file
+- [generateSpaceman](./generateSpaceman.md)
diff --git a/docs/api/generateSpaceman.md b/docs/api/generateSpaceman.md
index 332531d1..29e3d787 100644
--- a/docs/api/generateSpaceman.md
+++ b/docs/api/generateSpaceman.md
@@ -73,4 +73,4 @@ While the function comes with default options, you can customize various aspects
 
 - [generateCharacterSpritesheet](./generateCharacterSpritesheet.md)
 - [generateNinja](./generateNinja.md)
-- [generateRobot](./generateRobot.md)
\ No newline at end of file
+- [generateRobot](./generateRobot.md)
