Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 1.98 KB

README.md

File metadata and controls

84 lines (65 loc) · 1.98 KB
GHBanner

CharacterForge

AI Character & Avatar Generator for Apps, Games & Design. Generate production-ready 3D characters with React components and REST API.

Quick Start

Prerequisites: Node.js

  1. Install dependencies:

    npm install

  2. Set environment variables in .env.local:

    GEMINI_API_KEY=your_gemini_api_key
VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

  3. Run the app:

    npm run dev

Documentation

📚 Full Documentation - Complete guide for:

  • React Component usage
  • React Native Component usage
  • REST API reference
  • Configuration options
  • Code examples

Features

  • 🎨 AI Character & Avatar Generation - Create stylized 3D characters for games, apps, and design
  • ⚛️ React Components - Drop-in components for React and React Native
  • 🔌 REST API - Full programmatic access for developers
  • 🎯 Fully Customizable - Gender, age, skin tone, hair, clothing, accessories, and more
  • 🖼️ Production-Ready Assets - Transparent PNGs perfect for any project
  • 💳 Simple Pricing - Pay only for what you generate, starting at $0.10

Installation

React

npm install @characterforge/react

React Native

npm install @characterforge/react-native

Quick Example

import { CharacterForge } from '@characterforge/react';

export const MyCharacter = () => {
  return (
    <CharacterForge
      apiKey={process.env.CHARACTER_FORGE_KEY}
      config={{
        gender: 'female',
        skinTone: 'light',
        hairStyle: 'bob',
        clothingColor: 'blue'
      }}
    />
  );
};

Links