Class: RubySpriter::Consolidator

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_spriter/consolidator.rb

Overview

Consolidates multiple spritesheets vertically

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Consolidator

Returns a new instance of Consolidator.



10
11
12
 
# File 'lib/ruby_spriter/consolidator.rb', line 10

def initialize(options = {})
  @options = options
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



8
9
10
 
# File 'lib/ruby_spriter/consolidator.rb', line 8

def options
  @options
end

Instance Method Details

#consolidate(files, output_file) ⇒ Hash

Consolidate multiple spritesheets into one

Parameters:

  • files (Array<String>) —

    Array of spritesheet file paths

  • output_file (String) —

    Output consolidated file path

Returns:

  • (Hash) —

    Processing results



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ruby_spriter/consolidator.rb', line 18

def consolidate(files, output_file)
  validate_files!(files)

  Utils::OutputFormatter.header("Consolidating Spritesheets")

  metadata_list = read_all_metadata(files)
  validate_compatibility!(metadata_list) if options[:validate_columns]

  create_consolidated_image(files, output_file)

  total_frames = metadata_list.sum { |m| m[:frames] }
  columns = metadata_list.first[:columns]
  rows = (total_frames.to_f / columns).ceil

  # Embed consolidated metadata
  temp_file = output_file.sub('.png', '_temp.png')
  File.rename(output_file, temp_file)

  MetadataManager.embed(
    temp_file,
    output_file,
    columns: columns,
    rows: rows,
    frames: total_frames,
    debug: options[:debug]
  )

  File.delete(temp_file) if File.exist?(temp_file)

  file_size = File.size(output_file)

  # Display results with Godot instructions
  display_consolidation_results(output_file, file_size, files, metadata_list, columns, rows, total_frames)

  {
    output_file: output_file,
    columns: columns,
    rows: rows,
    frames: total_frames,
    size: file_size
  }
end

#find_spritesheets_in_directory(directory) ⇒ Array<String>

Find all PNG files with spritesheet metadata in a directory

Parameters:

  • directory (String) —

    Directory path to scan

Returns:

  • (Array<String>) —

    Sorted array of spritesheet file paths



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/ruby_spriter/consolidator.rb', line 64

def find_spritesheets_in_directory(directory)
  # Validate directory exists
  unless File.directory?(directory)
    raise ValidationError, "Directory not found: #{directory}"
  end

  # Find all PNG files
  pattern = File.join(directory, '*.png')
  png_files = Dir.glob(pattern)

  # Filter to only files with metadata
  spritesheets = png_files.select do |file|
    metadata = MetadataManager.read(file)
    !metadata.nil?
  end

  # Validate we found at least one
  if spritesheets.empty?
    raise ValidationError, "No PNG files with spritesheet metadata found in directory: #{directory}"
  end

  # Validate we have at least 2
  if spritesheets.length < 2
    raise ValidationError, "Found only #{spritesheets.length} spritesheet, need at least 2 for consolidation"
  end

  # Sort alphabetically by filename
  spritesheets.sort
end