NEXXT

Parser for NEXXT Studio (NES graphics editor) session files.

Installation

Add this line to your application's Gemfile:

gem 'nexxt-parser'

And then execute:

bundle install

Usage

Parse a session file

require 'nexxt-parser'

session = NEXXT::Parser::Session.read('path/to/file.nss')

# Access CHR data
session.chr_main  # => Array of integers
session.chr_copy # => Array of integers

# Access metasprites
session.metasprites.each do |metasprite|
  puts metasprite.name
  metasprite.sprites.each do |sprite|
    puts "  x: #{sprite.x}, y: #{sprite.y}, tile: #{sprite.tile}"
  end
end

Access the session map / nametable

session = NEXXT::Parser::Session.read('path/to/file.nss')

map = session.map
map.width       # => Integer (in tiles)
map.height      # => Integer
map.tiles       # => 2D array of tile indices
map.attributes  # => Raw attribute bytes
map.metatiles   # => Array of Metatile objects

session.palette # => Array of NES palette bytes (from the Palette entry)

Export the nametable as a PNG

session = NEXXT::Parser::Session.read('path/to/file.nss')
session.export_png('out.png')

# Optional overrides: chr_bank (0..3), palette_bank (0..3), custom nes_palette
session.export_png('out.png', chr_bank: 1, palette_bank: 0)

The exporter uses a built-in 2C02 NES RGB palette; pass a 64-entry array of [r, g, b] triples as nes_palette: to swap in a different one.

Parse a standalone map file

map = NEXXT::Parser::Map.read('path/to/file.map')

map.width   # => Integer
map.height  # => Integer
map.tiles   # => 2D array of tile indices
map.metatiles # => Array of Metatile objects

Development

After checking out the repo, run bundle install to install dependencies. Then, run bundle exec rspec to run the tests.

Run bundle exec rubocop for linting.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/wendelscardua/nexxt-parser.

License

The gem is available as open source under the terms of the MIT License.