Ruby Spriter v0.7.0.1

Professional MP4 to Spritesheet Converter with Advanced Image Processing

A powerful cross-platform Ruby tool for creating high-quality spritesheets from video files and processing them with professional-grade image manipulation. Perfect for game development workflows, particularly with Godot Engine.

• 🎬 Video to Spritesheet - Extract frames from MP4 videos using FFmpeg
• 🖼️ Advanced Image Processing - Scale, sharpen, and remove backgrounds with precision
• 🎨 Quality Enhancement - 5 interpolation methods and configurable unsharp masking
• 🎞️ Frame-by-Frame Processing - Process each video frame individually for varying backgrounds (v0.7.0.1+)
• 📐 Spritesheet Consolidation - Merge multiple spritesheets vertically
• 📊 Metadata Management - Embed, verify, and add grid information to PNG files
• 📦 Batch Processing - Process multiple MP4 files in a directory automatically (v0.6.7+)
• 🗜️ Maximum Compression - Optimal PNG compression while preserving metadata (v0.6.7+)
• 🌍 Cross-Platform - Works seamlessly on Windows, Linux, and macOS
• 🧪 Production Ready - Comprehensive RSpec test coverage (512+ tests)

gem install ruby_spriter

ruby_spriter --check-dependencies

# Create 4x4 grid with 16 frames
ruby_spriter --video input.mp4

# Remove background
ruby_spriter --video input.mp4 --remove-bg

# Scale and compress
ruby_spriter --video input.mp4 --scale 50 --max-compress

# Batch process entire directory
ruby_spriter --batch --dir "videos/" --remove-bg

Complete documentation is organized into focused guides:

• Ruby 2.7.0 or higher
• No runtime gem dependencies (uses Ruby standard library)

• Video Input: MP4 only
• Image Input/Output: PNG only

# Character animation for Godot
ruby_spriter --video character_walk.mp4 \
  --frames 16 --columns 4 \
  --scale 50 --remove-bg --sharpen

# VFX effects with high frame count
ruby_spriter --video explosion.mp4 \
  --frames 64 --columns 8 \
  --scale 75 --interpolation nohalo

# Consolidate 8-directional walk cycles
ruby_spriter --consolidate --dir "walk_cycles/" \
  --output character_walk_all.png

# Process entire animation library
ruby_spriter --batch --dir "raw_animations/" \
  --outputdir "game_assets/" \
  --scale 50 --remove-bg --max-compress

# Batch with consolidation
ruby_spriter --batch --dir "states/" \
  --batch-consolidate --output character_all.png

# Frame-by-frame for videos with changing backgrounds
ruby_spriter --video animation.mp4 \
  --remove-bg --by-frame \
  --frames 32 --columns 8

# Batch process with frame-by-frame
ruby_spriter --batch --dir "animations/" \
  --remove-bg --by-frame --scale 50

• Inner Background Removal - Remove interior background regions (v0.7.0+)
• Threshold Stepping - Process with multiple thresholds for superior edges (v0.7.0+)
• Ghost Edge Prevention - Multi-pass cleanup of semi-transparent artifacts (v0.7.0+)
• Smoke Detection - Identify and remove transparency gradients (v0.7.0+)
• Frame Extraction - Extract specific frames by number (v0.7.0+)
• Metadata Addition - Add grid information to external spritesheets (v0.7.0+)
• Cell-Based Cleanup - Post-process residual backgrounds per-cell (v0.7.0.1+, experimental)

This project is licensed under the MIT License - see the LICENSE file for details.

• GitHub: https://github.com/scooter-indie/ruby-spriter
• Issues: https://github.com/scooter-indie/ruby-spriter/issues
• Changelog: CHANGELOG.md
• Developer Docs: CLAUDE.md

• FFmpeg - Video processing foundation
• GIMP - Professional image manipulation
• ImageMagick - Metadata and image operations
• Ruby Community - Excellent standard library

Made with ❤️ for game developers