NO6KIKO/gorest-2d-animation-spritesheet-generator

Gorest 2D Animation Spritesheet Generator

What it is – An open‑source, web‑based editor for building 2‑D game scenes and producing animation‑ready spritesheets. The tool has no graphical UI in the traditional sense; you work by describing what you want (or by dragging assets) and a local Codex‑powered agent updates the project files for you. It can generate, import, and edit spritesheets, attach metadata (action name, direction, loop mode, triggers, etc.), and preview the result directly in the browser.

Why it matters – Creating 2‑D game assets normally involves a manual pipeline (draw frames → assemble a sheet → add metadata → import into a game engine). Gorest automates that loop: a prompt to Codex can create a full transparent PNG spritesheet, the app instantly shows a playback preview, and you can tweak layer order, scene composition, and interaction data without leaving the browser. It also supports a “fake‑3D” viewer that rotates pre‑rendered spritesheets to give the illusion of a 3‑D object.

Key features

• Scene composer – free‑form canvas where you place backgrounds, characters, props, UI elements and animated sprites as separate layers.
• Spritesheet page – lists every sheet used in the current scene, lets you preview, download, and edit per‑clip metadata.
• Codex‑assisted workflow – write natural‑language prompts (e.g., “generate a 16‑frame goldfish bowl spritesheet”) and the local agent creates or updates assets automatically.
• Metadata‑rich assets – each clip stores role, clip name, trigger type/value, game state, direction, loop mode, tags, and optional viewMode for the fake‑3D rotator.
• Fake‑3D object rotation – view a spritesheet as a turntable with configurable azimuth/elevation frames, sensitivities, and auto‑rotate.
• Local‑first storage – all generated PNGs and a game_asset_library.json are saved under public/generated/, making the prototype self‑contained.
• Keyboard shortcuts – standard copy/paste, undo/redo, duplicate, delete, etc., for rapid scene editing.
• Deployable – npm run dev for development, npm run build + npm start for production.

Typical use‑cases

1. Rapid prototyping – designers can sketch a side‑scroller level, drop in animated props, and see how the game will look without exporting to a separate engine.
2. AI‑augmented asset creation – artists can describe a character or prop and let Codex generate a full spritesheet, then fine‑tune it in‑app.
3. Reusable asset library – once a sprite or prop is saved, it can be dragged into any future scene, preserving its metadata for gameplay logic.
4. Educational demos – teachers can show how 2‑D animation pipelines work and how LLM‑driven agents can automate repetitive steps.

Getting started

# 1. Install Node.js 20+
# 2. Clone the repo
git clone https://github.com/NO6KIKO/gorest-2d-animation-spritesheet-generator.git
cd gorest-2d-animation-spritesheet-generator

# 3. Install deps
npm install

# 4. Run locally
npm run dev   # opens http://localhost:3000 (or set PORT)

The app runs entirely locally; no API keys are required unless you later enable a cloud image‑generation service.

License – Code is released under the MIT License. Media assets (spritesheets, backgrounds, demo images) are provided for preview only and are not MIT‑licensed; see public/ASSET_LICENSE.md for their specific terms.

---

All information above is taken directly from the repository’s README; no additional features have been inferred.