nwn-lib 0.3.6 → 0.4.0

data/scripts/clean_locstrs.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env nwn-dsl
+
+# This FILTER walks all cexolocstrs and makes sure
+# that there are no stray language-ids.
+#
+# This is obviously only useful for single-language projects.
+
+want Gff::Struct
+
+count = 0
+
+self.each_by_flat_path do |label, field|
+  next unless field.is_a?(Gff::Cexolocstr)
+  next if field.v.size == 0
+
+  compactable = field.v.values.reject {|x| x == ""}.uniq.size < 2
+
+  unless will_output?
+    unless compactable
+      log "%s: need interactive." % [label]
+      log "  %s" % [field.v.inspect]
+    else
+      log "%s: can fix for myself." % label
+    end
+
+  else
+    str = nil
+    unless compactable
+      log "Cannot compact #{label}, because the contained strings are not unique."
+      selection = ask "Use what string?", field.v
+      log "Using: #{selection.inspect}"
+      str = field.v[selection.to_i]
+    else
+      str = field.v[field.v.keys.sort[0]]
+    end
+    field.v.clear
+    field.v[0] = str
+
+    field.str_ref = Gff::Field::DEFAULT_STR_REF
+
+    count += 1
+  end
+
+end
+
+log "#{count} str-refs modified." if will_output?

data/scripts/extract_all_items.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env nwn-dsl
+
+# This script will extract all items the worked-on
+# struct is currently in possession of.
+o = need ARGV.shift, :bic, :utc, :uti
+
+log "Extracting .."
+list = []
+list += o['Equip_ItemList'].field_value if o['Equip_ItemList']
+list += o['ItemList'].field_value if o['ItemList']
+log "#{list.size} items found."
+list.each_with_index {|item, index|
+  File.open(fname = "item_#{index}.uti", "w") {|file|
+    file.write item.to_gff("UTI")
+    log "Written item: #{item['Tag'].field_value} as #{fname}"
+  }
+}
+
+log "All done."

data/scripts/fix_facings.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env nwn-dsl
+
+# The nwn toolset sometimes does weird things with facings;
+# they flip signedness for no apparent reason.
+
+# This script fixes that by forcing all facings to be unsigned.
+
+want Gff::Struct
+
+count = 0
+
+self.each_by_flat_path do |label, field|
+	next unless field.is_a?(Gff::Field)
+	next unless field.field_type == :float
+	next unless label =~ %r{\[\d+\]/(Facing|Bearing)$}
+	if field.field_value < 0
+		field.field_value = field.field_value.abs
+		count += 1
+	end
+end
+
+log "#{count} bearings modified."

data/scripts/truncate_floats.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/env nwn-dsl
+
+# This truncates position floats to a sane width, thus avoiding
+# miniscule floating point differences in version control diffs.
+
+PRECISION = 4
+
+count = 0
+
+self.each_by_flat_path do |label, field|
+	next unless field.is_a?(Gff::Field)
+	next unless field.field_type == :float
+	field.field_value =
+		("%.#{PRECISION}f" % field.field_value).to_f
+	count += 1
+end
+
+log "#{count} floats truncated."

data/tools/migrate_03x_to_04x.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+# This script automages migrating <= 0.3.6-formatted YAML
+# dumps to the current format.
+# You need both versions of nwn-lib installed.
+set -e
+
+for in_yml in $@; do
+	if [ ! -e "$in_yml" ]; then
+		echo "$in_yml: does not exist"
+		exit 1
+	fi
+	tmp=$1.gff
+
+	echo -n "$in_yml: "
+	( nwn-gff-import _0.3.6_ -y $in_yml | nwn-gff -lg -ky > $tmp ) && mv $tmp $in_yml
+	echo "ok."
+done

data/tools/verify.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+cmp() {
+	gffcmp.pl -d $1 $2 | \
+		fgrep -v "File $2 do not match" | \
+		egrep -v "^Number of items in localized string array .* differ, " | \
+		egrep -v "^Localized string array .* differ, key .* missing$" | \
+		egrep -v "^Key .* missing from" | \
+		fgrep -v "Number of keys at level" | \
+		fgrep -v "First gff has extra key"
+}
+
+tmp=/tmp/nwn-gff-tmp
+
+for x in $@; do
+
+	echo "| $x: test kivinen printer: y -> k | cmp" | ts
+	nwn-gff -i$x -kk -t | gffencode.pl - -o $tmp
+	cmp $x $tmp
+
+	echo "| $x: test gff printer: y -> g | cmp" | ts
+	nwn-gff -i$x -kg > $tmp
+	cmp $x $tmp
+
+	echo "| $x: test marshal re-read: m -> m -> k | cmp" | ts
+	nwn-gff -i$x -km | nwn-gff -lm -kk -t | gffencode.pl - -o $tmp
+	cmp $x $tmp
+
+	echo "| $x: test yaml re-read: y -> y -> k | cmp" | ts
+	nwn-gff -i$x -ky | nwn-gff -ly -ky | tee /tmp/blah | \
+		nwn-gff -ly -kk -t | gffencode.pl - -o $tmp
+	cmp $x $tmp
+done
+
+exit 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nwn-lib
 version: !ruby/object:Gem::Version 
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors: 
 - Bernhard Stoeckner
@@ -9,21 +9,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-10 00:00:00 +01:00
+date: 2009-02-03 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
 description: a ruby library for accessing Neverwinter Nights resource files
 email: elven@swordcoast.net
 executables: 
-- nwn-gff-print
-- nwn-gff-irb
-- nwn-gff-import
+- nwn-gff
+- nwn-dsl
+- nwn-irb
 extensions: []
 
 extra_rdoc_files: 
 - README
 - BINARIES
+- DATA_STRUCTURES
+- SCRIPTING
+- SETTINGS
+- TYPE_VALUE_INFERRING
 - CHEATSHEET
 - CHANGELOG
 - COPYING
@@ -32,17 +36,41 @@ files:
 - CHANGELOG
 - README
 - Rakefile
-- bin/nwn-gff-irb
-- bin/nwn-gff-print
-- bin/nwn-gff-import
+- bin/nwn-dsl
+- bin/nwn-gff
+- bin/nwn-irb
 - spec/spec.opts
 - spec/rcov.opts
 - lib/nwn
+- lib/nwn/scripting.rb
 - lib/nwn/yaml.rb
 - lib/nwn/twoda.rb
+- lib/nwn/settings.rb
 - lib/nwn/gff.rb
+- lib/nwn/infer.rb
+- lib/nwn/kivinen.rb
+- lib/nwn/all.rb
 - lib/nwn/helpers.rb
+- lib/nwn/gff
+- lib/nwn/gff/field.rb
+- lib/nwn/gff/reader.rb
+- lib/nwn/gff/cexolocstr.rb
+- lib/nwn/gff/struct.rb
+- lib/nwn/gff/list.rb
+- lib/nwn/gff/writer.rb
+- lib/nwn/gff/api.rb
+- tools/verify.sh
+- tools/migrate_03x_to_04x.sh
+- scripts/truncate_floats.rb
+- scripts/fix_facings.rb
+- scripts/clean_locstrs.rb
+- scripts/extract_all_items.rb
+- data/gff-common-nwn1.yaml
 - BINARIES
+- DATA_STRUCTURES
+- SCRIPTING
+- SETTINGS
+- TYPE_VALUE_INFERRING
 - CHEATSHEET
 has_rdoc: true
 homepage: http://nwn-lib.elv.es

data/bin/nwn-gff-import

@@ -1,69 +0,0 @@
-#!/usr/bin/ruby
-require 'rubygems'
-require 'optparse'
-require 'nwn/gff'
-require 'nwn/helpers'
-require 'yaml'
-
-format = nil
-postfix = nil
-outfile = nil
-
-OptionParser.new do |o|
-  o.banner = "Usage: nwn-gff-import [options] file/- [file, file, file]"
-
-  o.on "-y", "--yaml", "Import as yaml" do
-    format = :yaml
-  end
-  o.on "-m", "--marshal", "Import as native ruby marshal data" do
-    format = :marshal
-  end
-
-  o.on "-o", "--outfile F", "Write to outfile instead of stdout" do |out|
-    outfile = out
-  end
-
-  o.on "--postfix P", "Strip the given postfix from file and write to that instead of stdout (overrides -o)" do |p|
-    postfix = p
-  end
-
-end.parse!
-
-ARGV.size > 0 or begin
-  $stderr.puts "Required argument: filename to read, or - for stdin (try -h)."
-  exit 1
-end
-
-ARGV.each do |infile|
-  data = nil
-
-  if !postfix && !outfile
-    outfile = $stdout
-  elsif postfix && outfile
-    outfile = outfile.gsub(/#{Regexp.escape(postfix)}$/, "")
-    outfile = File.new(outfile, "w")
-  elsif outfile && !postfix
-    outfile = File.new(outfile, "w")
-  end
-
-  inbytes = infile == "-" ? $stdin.read : IO.read(infile)
-
-  case format
-    when :yaml
-      data = YAML.load(inbytes)
-    when :marshal
-      data = Marshal.load(inbytes)
-    else
-      raise ArgumentError, "Unknown format; try -h"
-  end
-
-  raise ArgumentError, "Input stream is NOT a valid gff object" unless
-    data.is_a?(NWN::Gff::Gff)
-
-  outbytes = NWN::Gff::Writer.dump(data)
-
-
-  outfile.write(outbytes)
-
-  outfile.close
-end

data/bin/nwn-gff-irb

@@ -1,62 +0,0 @@
-#!/usr/bin/ruby
-require 'rubygems'
-require 'optparse'
-require 'nwn/gff'
-require 'nwn/twoda'
-require 'yaml'
-require 'irb'
-require 'irb/completion'
-
-OptionParser.new do |o|
-  o.banner = "Usage: nwn-gff-irb file"
-end.parse!
-
-file = ARGV.shift or begin
-  $stderr.puts "Required argument: filename to process, or - for stdin (try -h)."
-  exit 1
-end
-
-if file == "-"
-  bytes = $stdin.read
-else
-  bytes = IO.read(file)
-end
-$file = File.expand_path(file)
-
-if File.extname($file) == ".yml"
-  GFF = YAML.load(bytes)
-else
-  GFF = NWN::Gff::Reader.read(bytes)
-end
-
-def save destination = nil
-  destination ||= $file
-  puts "Saving to ´#{destination}' .."
-  if File.extname($file) == ".yml"
-    bytes = GFF.to_yaml
-  else
-    bytes = NWN::Gff::Writer.dump(GFF)
-  end
-  File.open(destination, "w") {|f|
-    f.write(bytes)
-  }
-  puts "saved."
-end
-
-if __cache_location = ENV['NWN2DAHOME']
-  require 'nwn/helpers'
-  puts "Setting up 2da cache at #{__cache_location} .."
-  NWN::TwoDA::Cache.setup __cache_location
-else
-  puts "Warning: Environment variable `NWN2DAHOME' is not available, not using 2da cache (helpers not available)."
-end
-
-include NWN::Gff
-include NWN::TwoDA
-
-puts "Your GFF file is in `GFF' (type: #{GFF.type.inspect})."
-puts "Type `save' to save to the filename it came from (make a backup!), `exit' (or Ctrl+D) to exit (without saving)."
-puts "To save to a different location, type `save \"path/to/new/location.ext\"'."
-puts ""
-
-IRB.start

data/bin/nwn-gff-print

@@ -1,133 +0,0 @@
-#!/usr/bin/ruby
-require 'rubygems'
-require 'optparse'
-require 'nwn/gff'
-require 'nwn/helpers'
-require 'yaml'
-require 'nwn/yaml'
-
-format = nil
-types_too = false
-full = false
-file_type = nil
-struct_id = nil
-path = nil
-prefix = :none
-postfix = nil
-verbose = false
-options = {}
-
-OptionParser.new do |o|
-  o.banner = "Usage: nwn-gff-print [options] file/- [file, file, ..]"
-
-  o.on "-y", "--yaml", "Dump as yaml" do
-    format = :yaml
-  end
-
-  o.on "-k", "--kivinen", "Dump as kivinens dump format (like the perl tools)" do
-    format = :kivinen
-  end
-  o.on "--kivinen-full-path", "Print the full path (implies -k)" do
-    format = :kivinen
-    full = true
-  end
-
-  o.on "-b", "--print-basename", "Prefix the file basename to the output" do |b|
-    prefix = :base
-  end
-  o.on "-f", "--print-filename", "Prefix the full filename to the output" do |b|
-    prefix = :full
-  end
-
-  o.on "-t", "--print-types", "Print types as well" do
-    types_too = true
-  end
-
-  o.on "-m", "--marshal", "Native ruby marshalling. Warning: raw bytes" do
-    format = :marshal
-  end
-
-  o.on "--postfix P", "Write output to file postfixed with P instead of stdout" do |p|
-    postfix = p
-  end
-
-  o.on "--float_rounding F", "Round floating point numbers to the specified number of righthand digits" do |fr|
-    options[:float_rounding] = fr.to_i
-  end
-
-  o.on "--type filetype", "Override the file type (implies --struct 0xffffffff)" do |t|
-    if t.size != 3
-      $stderr.puts "Invalid type #{t} passwd."
-      exit 1
-    end
-    file_type = t.upcase + " "
-    struct_id = 0xffffffff
-  end
-
-  o.on "--struct id", "Override struct id (as hex, please)" do |s|
-    struct_id = s.hex
-  end
-  o.on "-p=path", "--path path", "Only print the given path" do |p|
-    path = p
-  end
-
-  o.on "-v", "--verbose", "Be verbose" do
-    verbose = true
-  end
-end.parse!
-
-ARGV.size > 0 or begin
-  $stderr.puts "Required argument: filename to read, or - for stdin (try -h)."
-  exit 1
-end
-
-ARGV.each {|file|
-
-  if file == "-"
-    bytes = $stdin.read
-  else
-    bytes = IO.read(file)
-  end
-
-  g = NWN::Gff::Reader.read(bytes, options)
-
-  if path
-    begin
-      g = g[path]
-    rescue Exception => e
-      $stderr.puts "Error: " + e.to_s
-      exit 1
-    end
-  end
-
-  my_prefix = case prefix
-    when :none
-      ""
-    when :base
-      File.basename(file) + ": "
-    when :full
-      File.expand_path(file) + ": "
-  end
-
-  write_to = postfix ? File.new(file + postfix, "w") : $stdout
-  $stderr.puts "Processing `#{file}`" if verbose
-  case format
-    when :yaml
-      if prefix == :none
-        write_to.puts g.to_yaml
-      else
-        write_to.puts g.to_yaml.split("\n").map {|ln| my_prefix + ln }.join("\n")
-      end
-    when :kivinen
-      NWN::Gff.kivinen_format g, my_prefix + "/", types_too, full, file_type, struct_id do |label, value|
-        write_to.puts "%s:\t%s" % [label, value]
-      end
-    when :marshal
-      write_to.print Marshal.dump(g)
-    else
-      $stderr.puts "Unknown format; try -h"
-      exit 1
-  end
-
-  write_to.close if postfix
-}