rbstarbound 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc2319a0b69674dfcdccfd64791c37858fecc10f
+  data.tar.gz: 7fe512695536fd226115bc2116786145865f71c2
+SHA512:
+  metadata.gz: 8a1fe19f1faa35fdaabe9e0bcd0ff1c2ba8f6cd9adb9f5a298efe9c15ced2c9596c02bcf2057e3750cd6f26c4e7f51f74a9522b5f23650fe307f31d5211fb38e
+  data.tar.gz: 86452ce8a5f13cd43bcdec1b217bcd7992a634226dfde90c8ae9dd405e39e618b84286da2902f4f5a90d81198c5161306abb6245e94e7eeae42d42d5eabee223

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Oleh Fedorenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,105 @@
+# RBStarbound
+
+This is a library to parse
+[Starbound's](https://playstarbound.com/)
+file formats which are used to store worlds, player characters, assets, etc.
+
+Frankly, it's just a ruby version of
+[py-starbound](https://github.com/blixt/py-starbound).
+All thanks to
+[blixt](https://github.com/blixt).
+
+--------------------------------------------------------------------------------
+## Installation
+
+#### I. option
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rbstarbound'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rbstarbound
+
+#### II. option
+
+You just
+
+    $ git clone https://github.com/JetPirate/rb-starbound.git
+    $ cd rb-starbound
+
+--------------------------------------------------------------------------------
+
+## Usage
+
+### with executables
+
+To get YAML file with all parsed player data:
+
+**Attention: will be changed!**
+
+    $ ./bin/rbstarbound path/to/save/file path/to/output/file
+
+... will be added ...
+
+### with the gem/library
+
+#### Exapmle 1: Get the player name
+
+```ruby
+
+require 'rbstarbound'
+
+path = 'path/to/your/save/file'
+player = RBStarbound.parse_player_save_file(path)
+# simple way
+puts player.player_name
+# advanced way
+puts player['data']['identity']['name']
+
+```
+
+... will be added ...
+
+--------------------------------------------------------------------------------
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Feel free to contribute either via submitting pull requests or writing up
+issues with suggestions and/or bugs.
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/JetPirate/rb-starbound.
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org)
+code of conduct.
+
+--------------------------------------------------------------------------------
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RBStarbound project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct
+](https://github.com/JetPirate/rb-starbound/blob/master/CODE_OF_CONDUCT.md).

data/bin/rbstarbound

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rbstarbound'
+require 'yaml'
+unless ARGV.count == 2
+  puts 'You need to input file paths'
+  return
+end
+player = RBStarbound.parse_player_save_file(ARGV[0].to_s)
+File.open(ARGV[1].to_s, 'w') do |file|
+  file.write(player['data'].to_yaml)
+end

data/lib/rbstarbound/exceptions.rb

@@ -0,0 +1,5 @@
+module RBStarbound
+  class NotImplementedError < StandardError; end
+  class SBVJ01Error < StandardError; end
+  class ValueError < StandardError; end
+end

data/lib/rbstarbound/sbon.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RBStarbound
+  module SBON
+    def self.read_varint(io)
+      value = 0
+      loop do
+        byte = io.readchar.ord
+        return value << 7 | byte if (byte & 0b10_00_00_00).zero?
+        value = value << 7 | (byte & 0b01_11_11_11)
+      end
+    end
+
+    def self.read_varint_signed(io)
+      value = read_varint(io)
+      # Least significant bit represents the sign.
+      return -(value >> 1) - 1 unless (value & 1).zero?
+      value >> 1
+    end
+
+    def self.read_bytes(io)
+      length = read_varint(io)
+      io.read(length)
+    end
+
+    def self.read_string(io)
+      read_bytes(io)
+    end
+
+    def self.read_list(io)
+      list = []
+      read_varint(io).times do
+        list << read_dynamic(io)
+      end
+      list
+    end
+
+    def self.read_map(io)
+      map = {}
+      read_varint(io).times do
+        key = read_string(io)
+        map[key] = read_dynamic(io)
+      end
+      map
+    end
+
+    def self.read_dynamic(io)
+      case read_ord(io)
+      when 1 then nil # nil value
+      when 2 then io.read(8).unpack('G')[0] # double; big-endian
+      when 3 then !read_ord(io).zero? # boolean value
+      when 4 then read_varint_signed(io) # VLQ; signed
+      when 5 then read_string(io) # string value
+      when 6 then read_list(io) # list value (array)
+      when 7 then read_map(io) # map value (hash)
+      else raise RBStarbound::ValueError, 'Unknown dynamic type'
+      end
+    end
+
+    def self.read_ord(io)
+      io.readchar.ord
+    end
+
+    class << self
+      private :read_ord
+    end
+  end
+end

data/lib/rbstarbound/sbvj01.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RBStarbound
+  module SBVJ01
+    Player = Struct.new(:name, :version, :data) do
+      def player_name
+        data['identity']['name']
+      end
+
+      def uuid
+        data['identity']['uuid']
+      end
+    end
+
+    def self.parse(io)
+      unless sbvj01_header?(io)
+        raise RBStarbound::SBVJ01Error, 'Not a SBVJ01 file'
+      end
+      get_player_data(io)
+    end
+
+    def self.write(io)
+      raise RBStarbound::NotImplementedError
+    end
+
+    def self.get_player_data(io)
+      name = RBStarbound::SBON.read_string(io)
+      version = 'None'
+      version = io.read(4).unpack('i>') if io.readchar.ord != 0
+      data = RBStarbound::SBON.read_dynamic(io)
+      Player.new(name, version, data)
+    end
+
+    def self.sbvj01_header?(io)
+      io.read(6) == 'SBVJ01'
+    end
+
+    class << self
+      private :write, :get_player_data, :sbvj01_header?
+    end
+  end
+end

data/lib/rbstarbound/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RBStarbound
+  VERSION = '0.1.0'
+end

data/lib/rbstarbound.rb

@@ -0,0 +1,21 @@
+require 'rbstarbound/version'
+require 'rbstarbound/exceptions'
+require 'rbstarbound/sbvj01'
+require 'rbstarbound/sbon'
+
+module RBStarbound
+  def self.ping
+    puts 'Pong!'
+  end
+
+  def self.parse_player_save_file(path)
+    save_file = File.open(path, 'rb')
+    parsed_data = SBVJ01.parse(save_file)
+  rescue StandardError => e
+    puts 'An error occured: ' + e.message.split(' @ ').first
+  else
+    return parsed_data
+  ensure
+    save_file.close unless save_file.nil?
+  end
+end

data/test/rbstarbound_test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class RBStarboundTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::RBStarbound::VERSION
+  end
+
+  def test_it_does_ping
+    expected_output = "Pong!\n"
+    assert_output(expected_output) { ::RBStarbound.ping }
+  end
+
+  def test_it_parses_save_file
+    expected_output = 'PlayerEntity'
+    output = ::RBStarbound.parse_player_save_file(SAVE_FILE_PATH)['name']
+    assert_equal(expected_output, output)
+  end
+
+  def test_it_shows_error_when_no_file_or_dir
+    expected_output = ERROR_MSG + "No such file or directory\n"
+    assert_output(expected_output) { ::RBStarbound.parse_player_save_file('') }
+  end
+end

data/test/sbvj01_test.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class SBVJ01Test < Minitest::Test
+  def test_it_raises_header_error
+    file = Tempfile.new('sbvj01_header_test_temp')
+    assert_raises RBStarbound::SBVJ01Error do
+      ::RBStarbound::SBVJ01.parse(file)
+    end
+    file.close
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rbstarbound'
+
+require 'minitest/autorun'
+
+data_version = ENV['TEST_DATA_VERSION'] || '1.3.3'
+
+SAVE_FILE_PATH = File.expand_path("test/data/#{data_version}/test.player")
+
+ERROR_MSG = 'An error occured: '

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rbstarbound
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleh Fedorenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- fpostoleh@gmail.com
+executables:
+- rbstarbound
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/rbstarbound
+- lib/rbstarbound.rb
+- lib/rbstarbound/exceptions.rb
+- lib/rbstarbound/sbon.rb
+- lib/rbstarbound/sbvj01.rb
+- lib/rbstarbound/version.rb
+- test/data/1.3.3/test.player
+- test/rbstarbound_test.rb
+- test/sbvj01_test.rb
+- test/test_helper.rb
+homepage: https://github.com/JetPirate/rb-starbound
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A simple gem/library for working with Starbound files.
+test_files:
+- test/sbvj01_test.rb
+- test/data/1.3.3/test.player
+- test/rbstarbound_test.rb
+- test/test_helper.rb