Skip to content

Revamp Documentation with a Touch of British Charm #452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 32 additions & 30 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,74 +1,76 @@
# Getting Started with SpriteAI
# SpriteAI: Jolly Good Sprite Generation

Welcome to SpriteAI! This guide will walk you through the process of integrating the SpriteAI npm package into your projects.
## Getting Started, Old Chap!

## Installation
Righto! Welcome to SpriteAI, the smashing npm package that'll have you generating sprites faster than you can say 'Bob's your uncle'!

To begin using SpriteAI, you'll need to install it in your project directory. Simply run the following command:
## Installation: Quick as a Cup of Tea

Pop open your terminal and run this brilliant command:

```bash
npm install spriteai
```

## Basic Usage
## Basic Usage: Bob's Your Sprite!

Once SpriteAI is installed, you can start leveraging its powerful features in your project. Here's a quick example demonstrating the main functionalities:
Once SpriteAI is nestled in your project, you'll be generating sprites with the precision of a Royal Navy navigator:

```javascript
const spriteAI = require('spriteai');

// Initialise a new SpriteAI instance
// Initialise a new SpriteAI instance, like brewing a perfect cuppa
const ai = new spriteAI.SpriteAI();

// Generate a sprite
// Generate a sprite that'll make the Queen proud
ai.generateSprite('player', 32, 32)
.then(sprite => {
console.log('Sprite successfully generated:', sprite);
console.log('Sprite generated with imperial excellence:', sprite);
})
.catch(error => {
console.error('Sprite generation encountered an error:', error);
console.error('Blimey! Sprite generation went a bit pear-shaped:', error);
});

// Load an existing sprite
// Load an existing sprite, as smooth as afternoon tea
ai.loadSprite('path/to/sprite.png')
.then(sprite => {
console.log('Sprite successfully loaded:', sprite);
console.log('Sprite loaded with gentlemanly grace:', sprite);
})
.catch(error => {
console.error('Sprite loading encountered an error:', error);
console.error('Crikey! Sprite loading encountered a spot of bother:', error);
});

// Save a sprite
// Save a sprite, precise as a Royal Guard's march
ai.saveSprite(sprite, 'path/to/save/sprite.png')
.then(() => {
console.log('Sprite saved successfully');
console.log('Sprite saved with top-notch efficiency');
})
.catch(error => {
console.error('Sprite saving encountered an error:', error);
console.error('Oh, balderdash! Sprite saving went a bit wonky:', error);
});
```

## Key Features
## Frightfully Useful Features

SpriteAI offers a range of powerful features to enhance your sprite creation and manipulation:
SpriteAI offers a right proper set of capabilities to enhance your sprite creation:

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)`.
1. **Sprite Generation**: Conjure up sprites with `generateSprite(name, width, height)` - brilliant!
2. **Sprite Loading**: Retrieve existing sprites with the ease of ordering a pint
3. **Sprite Saving**: Preserve your digital artwork with `saveSprite(sprite, path)`

## Advanced Techniques
## Advanced Techniques: Not Just for Toffs!

SpriteAI is capable of much more than basic sprite operations. You can create intricate sprite animations, apply various transformations, and unlock a world of creative possibilities. Dive into our comprehensive API documentation to explore the full potential of SpriteAI.
SpriteAI isn't merely a one-trick pony. You can craft intricate sprite animations, apply dashing transformations, and unlock a world of creative possibilities that would make even the most stoic British gentleman raise an eyebrow.

## Next Steps
## Your Next Steps, Chum

To truly master SpriteAI, we recommend:

1. Exploring the full API documentation
2. Experimenting with complex sprite animations
3. Applying different transformations to your sprites
4. Joining our community forums for tips and inspiration
1. Exploring the full API documentation (pip pip!)
2. Getting experimental with sprite animations
3. Applying transformations with the precision of a Swiss watch
4. Joining our community forums for a spot of friendly banter and inspiration

For in-depth information and advanced usage scenarios, please refer to our extensive API documentation.
For thorough information and advanced scenarios, do consult our comprehensive API documentation.

Thank you for choosing SpriteAI. We're excited to see the amazing sprites you'll create with our package!
Cheerio, and happy sprite generating! We're positively chuffed to see the marvellous sprites you'll create with our package! 🎩🇬🇧