ramekin 0.2.8 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 822404007ec094a4910d097982e43afd844eaefa1b561a6a51b90c005c23e970
-  data.tar.gz: a67f165b4ac578fae530f10080743d503bda72ecc8e4aaffe19034db426abe65
+  metadata.gz: ede8bd8e5c78aa94652f19f2cb65a687684f39fe569bfa50954d49202e24b732
+  data.tar.gz: 46457849f8df89c43f9070fc3de92bf515c1550d897c78574f94c62aeb6d0a26
 SHA512:
-  metadata.gz: 49d18c1c3b746d6866b4aec8e8aa400b42a296437326fd0a76a7c5736aab1e92ed1ffa33d55c7053daa876b317e03d34cb85c29ccdd87dcb616057e5c2dc53b3
-  data.tar.gz: 3097307fb155950f8dbd239a36eba3e594220738066477fbd695d89a54f9faf848e00e8f7298ac837c0f18d27a89a0956b17f9779fdd65646412b62685ab1917
+  metadata.gz: 982278d0d678809e2132651ffbd8af5cac3352b4a1560bdfb4538689f394733becae31c8454e867ff170ed056d228af65b78df61787f8d1aadfbf7baa4537f98
+  data.tar.gz: ef74b770772546afb76a19a82f50c245fc54a39facfb5d187990821c23ffd66943735deff93eadeba9df1507d88fb6cef7cc8ed2f9e476c3972c316a59334e31

data/README.md

@@ -76,11 +76,14 @@ ramekin filename.rmk [flags]
             set up an SPC player if none is detected.
         --package my-cool-folder/
             create a package directory suitable for submission
-            to SMWC, complete with README and packaged samples.
+            to SMWC, complete with packaged samples.
         --wav filename.wav
         --wav filename.wav:N
-            (non-windows only)
             render N seconds of the file to WAV.
+            (non-windows only - windows users should use --play
+            and render from the SPCPlay program)
+        --vis filename.png
+            outputs AddmusicK's ARAM visualization to a specified file
 
 ramekin pack [flags]
     flags:

data/lib/ramekin/amk_runner.rb

@@ -78,49 +78,44 @@ module Ramekin
         binding.pry if ENV['RAMEKIN_DEBUG'] == '1'
       end
 
+      $stderr.puts(File.read(stats_file))
+
       return res
     end
 
+    def sampledir_name
+      @meta.sample_path || basename
+    end
+
     def export(outdir)
       Dir.chdir outdir do
         FileUtils.cp(@filename, "./#{basename}.rmk")
         FileUtils.cp(spc_file, "./#{basename}.spc")
-        FileUtils.cp(stats_file, "./#{basename}.stats.txt")
-        FileUtils.cp("#@workdir/Visualizations/#{basename}.png", "./#{basename}.png")
+
         File.write("./#{basename}.txt", @txt)
 
         if @meta.instruments.any?
-          FileUtils.mkdir_p("samples/#{basename}")
+          FileUtils.mkdir_p("./#{sampledir_name}")
           @meta.instruments.each do |inst|
-            FileUtils.cp(inst.sample_path, "./samples/#{basename}/#{inst.sample_name}")
+            FileUtils.cp(inst.sample_path, "./#{sampledir_name}/#{inst.sample_name}")
           end
         end
 
-        packs = @meta.instruments.map(&:pack).uniq
-
-        pack_info = packs.map do |pack|
-          out = StringIO.new
-          out << "  #{pack.name}"
-          out << " (posted by #{pack.authors.join(', ')})" if pack.authors.any?
-          out << "\n"
+        readme = @meta.readme&.value
 
-          out << "  - #{pack.url}"
-          out.string
-        end.join("\n\n")
+        if readme
+          File.write("./README.txt", <<~README)
+            #{readme}
 
-        readme = @meta.readme&.value || '(you should edit this space before publishing)'
+            --
 
-        File.write("./README.txt", <<~README)
-          #{readme}
+            #{basename}.txt was composed as #{basename}.rmk with Ramekin
+            https://codeberg.org/jneen/ramekin
 
-          --
-
-          #{basename}.txt was composed as #{basename}.rmk with Ramekin
-          https://codeberg.org/jneen/ramekin
-
-          Sample sources:
-          #{pack_info}
-        README
+            Sample sources:
+            #{@meta.pack_info}
+          README
+        end
       end
     end
 
@@ -132,6 +127,10 @@ module Ramekin
       "#@workdir/stats/#{basename}.txt"
     end
 
+    def vis_file
+      "#@workdir/Visualizations/#{basename}.png"
+    end
+
     def spc
       File.read(spc_file)
     end

data/lib/ramekin/cli.rb

@@ -53,12 +53,14 @@ module Ramekin
       $stderr.puts "            #{default_text}"
       $stderr.puts "        --package my-cool-folder/"
       $stderr.puts "            create a package directory suitable for submission"
-      $stderr.puts "            to SMWC, complete with README and packaged samples."
+      $stderr.puts "            to SMWC, complete with packaged samples."
       unless Ramekin.config.windows?
         $stderr.puts "        --wav filename.wav"
         $stderr.puts "        --wav filename.wav:N"
         $stderr.puts "            render N seconds of the file to WAV. Requires spct."
       end
+      $stderr.puts "        --vis filename.png"
+      $stderr.puts "            outputs AddmusicK's ARAM visualization to a specified file"
       $stderr.puts ""
       $stderr.puts "ramekin package [flags]"
       $stderr.puts "ramekin pack [flags]"
@@ -129,6 +131,8 @@ module Ramekin
           @sample_path = argv.shift or usage! 'missing path for --sample-path'
         when '--txt'
           @output_txt = argv.shift or usage! 'missing filename after --txt'
+        when '--vis'
+          @output_vis = argv.shift or usage! 'missing filename after --vis'
         when '--spc'
           @output_spc = argv.shift or usage! 'missing filename after --spc'
         when '--package'
@@ -219,12 +223,13 @@ module Ramekin
         exit 1
       end
 
-      unless @output_txt || @output_package || @output_spc
+      unless @output_txt || @output_package || @output_spc || @output_vis
         warn <<~WARN
           no output specified. use either:
             --txt my_cool_file.txt
             --spc my_cool_file.spc
             --package my_cool_output_dir
+            --vis my_cool_png.png
             --play
             --wav my_cool_file.wav
         WARN
@@ -236,7 +241,7 @@ module Ramekin
         File.write(@output_txt, txt)
       end
 
-      if @output_spc || @output_package
+      if @output_spc || @output_package || @output_vis
         runner = AMKRunner.new(@infile, channels.meta, txt)
         result = runner.compile
         unless result && result.success?
@@ -253,10 +258,10 @@ module Ramekin
         $stderr.puts <<~MSG
           Package directory generated at #{@output_package}
         MSG
+      end
 
-        $stderr.puts <<~MSG unless channels.meta.readme
-          Please remember to edit README.txt!
-        MSG
+      if @output_vis
+        FileUtils.cp(runner.vis_file, @output_vis)
       end
 
       if @wav_file
@@ -298,6 +303,8 @@ module Ramekin
         when '--list'
           @mode = :list
           @term = argv.shift || ''
+        else
+          usage!("unknown argument: #{h.inspect}")
         end
       end
 

data/lib/ramekin/meta.rb

@@ -14,7 +14,6 @@ module Ramekin
     attr_reader :volume
     attr_reader :tempo
     attr_reader :echo
-    attr_reader :sample_path
     def initialize(elements, sample_path=nil)
       @elements = elements
       @instruments = []
@@ -23,6 +22,41 @@ module Ramekin
       @options = {}
     end
 
+    def sample_path_unsafe
+      return @sample_path if @sample_path
+      game = @game&.value
+      title = @title&.value
+      author = @author&.value
+
+      game = nil if game && game.upcase == "N/A"
+
+      return "#{game} - #{title}" if game && title
+      return "#{author} - #{title}" if author && title
+      return title if title
+      nil
+    end
+
+    def pack_info
+      packs = self.instruments.map(&:pack).uniq
+
+      pack_info = packs.map do |pack|
+        out = StringIO.new
+        out << "  #{pack.name}"
+        out << " (posted by #{pack.authors.join(', ')})" if pack.authors.any?
+        out << "\n"
+
+        out << "  - #{pack.url}"
+        out.string
+      end.join("\n\n")
+    end
+
+    def sample_path
+      p = sample_path_unsafe
+      return nil if p.nil?
+
+      p.gsub(/[\\\/.]/, '_').gsub(/\s+/m, ' ')
+    end
+
     def echo_channel_bits
       (@echo_channels ||= Set.new).map { |x| 1 << x }.inject(0, &:|)
     end

data/lib/ramekin/renderer.rb

@@ -26,9 +26,6 @@ module Ramekin
       SMW::BUILTINS.each do |name, id|
         @instrument_index[name] = id
       end
-
-      # optional default octaves for instrument switching
-      @default_octaves = Hash.new(4)
     end
 
     def render(&b)
@@ -54,8 +51,15 @@ module Ramekin
       yield "  #comment #{m.comment.value.inspect}\n" if m.comment
       yield "}\n\n"
 
-      yield "; generated from #{@filename} by Ramekin\n"
+      yield "; generated from #{@filename} by Ramekin v#{RAMEKIN_VERSION}\n"
       yield "; https://codeberg.org/jneen/ramekin\n\n"
+      if m.instruments.any?
+        yield "; Sample Sources:\n"
+        m.pack_info.split("\n").each do |line|
+          yield "; #{line}\n"
+        end
+        yield "\n"
+      end
 
       amk = @track.meta.amk&.value || 4
       yield "#amk #{amk}\n"
@@ -70,7 +74,7 @@ module Ramekin
         yield "#path #{(m.sample_path || @filename.chomp('.rmk')).inspect}\n"
         yield "#samples {\n"
         if m.sample_groups.empty?
-          yield "  #default"
+          yield "  #default\n"
         else
           m.sample_groups.each do |group|
             yield "  ##{group.value}\n"
@@ -85,7 +89,6 @@ module Ramekin
         yield "#instruments {\n"
         m.instruments.each_with_index do |inst, i|
           @instrument_index[inst.name.value] = 30 + i
-          @default_octaves[inst.name.value] = inst.octave
           yield "  #{inst.to_amk}\n"
         end
         yield "}\n\n"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ramekin
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.1
 platform: ruby
 authors:
 - jneen
 bindir: gembin
 cert_chain: []
-date: 2025-03-22 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: strscan
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.6
 specification_version: 4
 summary: A tool for making SMW music with AddmusicK
 test_files: []