adventure_rl 0.0.1.pre.ld42

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 419aead10a1f774fe22958d32dc028016f1176fd9aaa7ed5774c2cfec570f6c6
+  data.tar.gz: b360c7689d0e920376812f90f1e600b8402d5a02e2271e22389ac7ef61778926
+SHA512:
+  metadata.gz: 3370836de93da89533476f2f828d086e630d9d143fb5ba03a9cfa30d536f28455a5f6343c7def30fcc4bb77e10d9dc9e77e5e9c051537022efa8100d6ab2e003
+  data.tar.gz: 1507a166dae00060b1d2d0d1fb467d671b7663eca6fbdc2bb0387216b52f2e8db69b9b3e8fe459724f5a87190ddbd1544e23a8e1af16e13bf38cac426cd2958a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+/rdoc/
+
+.byebug_history
+.virb/
+/ignore/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  "https://github.com/#{repo_name}"
+end
+
+group :development do
+  gem 'argument_parser', git: 'https://github.com/Noah2610/ArgumentParser'
+end
+
+# Specify your gem's dependencies in AdventureRL.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GIT
+  remote: https://github.com/Noah2610/ArgumentParser
+  revision: 3ac5b0083fd42ae8740d1d22d988f56c74a29470
+  specs:
+    argument_parser (1.0.0)
+
+PATH
+  remote: .
+  specs:
+    adventure_rl (0.0.1.pre.ld42)
+      gosu (~> 0.13.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    byebug (10.0.2)
+    docile (1.3.1)
+    gosu (0.13.3)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rdoc (6.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    virb (0.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  adventure_rl!
+  argument_parser!
+  awesome_print
+  bundler (~> 1.16)
+  byebug
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  rdoc (~> 6.0)
+  simplecov
+  virb
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Noah Rosenzweig
+
+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,31 @@
+# AdventureRL
+Point-N-Click adventure game framework, using real video recordings as animations.
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'adventure_rl'
+```
+And then execute:
+```
+$ bundle
+```
+Or install it yourself as:
+```
+$ gem install adventure_rl
+```
+
+## Documentation
+Documentation is being written and is available under the `doc/` directory  
+in the project's root directory.
+
+## Development
+We have just started this project, so this gem is highly __Work In Progress__.  
+
+While developing this framework, we are creating a [demo game][demo-url] with it.
+
+## License
+The gem is available as open source under the terms of the [MIT License][MIT-url].
+
+[demo-url]: https://github.com/Noah2610/AdventureRL-Demo
+[MIT-url]:  https://opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  ENV['COVERAGE'] = 'true'
+end
+
+task :default => :test

data/adventure_rl.gemspec

@@ -0,0 +1,48 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift lib  unless ($LOAD_PATH.include? lib)
+require 'AdventureRL/version'
+github_url = 'https://github.com/Noah2610/AdventureRL'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'adventure_rl'
+  spec.version       = AdventureRL::VERSION
+  spec.authors       = ['Noah Rosenzweig']
+  spec.email         = ['rosenzweig.noah@gmail.com']
+  spec.summary       = <<-SUMMARY_END
+  Game framework built on top of Gosu.
+  SUMMARY_END
+  spec.description   = <<-DESCRIPTION_END
+  This video game framework is written using the Gosu game development library.
+  It was originally intended to be used for writing Point-N-Click adventure games,
+  but has become a more general 2D video game framework.
+  It's interesting features include video and audio playback capabilities.
+  The project is definitely lacking some documentation.
+  Although I have been trying to write documentation using rdoc and write tests
+  with Minitest, I do not think that I have been doing either of those very successfully.
+  I don't think many people aside from myself will be able to use it properly,
+  as I have built it specifically for my needs.
+  Thank you for reading, have a nice day :)
+  DESCRIPTION_END
+  spec.homepage      = github_url
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'bundler',  '~> 1.16'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'rdoc',     '~> 6.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'virb'
+
+  spec.add_dependency             'gosu',     '~> 0.13.3'
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'adventure_rl'
+require 'irb'
+require 'virb/default'
+IRB.start(__FILE__)

data/bin/mkaudio

@@ -0,0 +1,196 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'argument_parser'
+
+class AudioGenerator
+  DEFAULTS = {
+    fps:        10,
+    extension:  'flac'
+  }
+  HELP_TEXT = <<-EOT
+  USAGE
+    #{$0} [options...] AUDIO_FILEPATH
+
+  AUDIO_FILEPATH
+    The path to a audio or video file,
+    from which to extract the audio into multiple
+    smaller audio files..
+    This argument is mandatory.
+
+  OPTIONS
+    --help, -h
+      Print this text and exit.
+
+    --base-directory, --directory, --dir, -d BASE_DIRECTORY
+      The path and base name of the directory
+      where the files will be put. The full directory
+      name will be created with the following format:
+        {BASE_DIRECTORY}.{FPS}F.{EXTENSION}
+      This option is mandatory.
+
+    --fps, -f FPS
+      The frames per second to use, as an integer.
+      Default: '#{DEFAULTS[:fps]}'
+
+    --extension, --ext, -e EXTENSION
+      The extension and audio format to use for the audio files.
+      Default: '#{DEFAULTS[:extension]}'
+  EOT
+  VALID_ARGUMENTS = {
+    single: {
+      help: [
+        [?h],
+        false
+      ],
+      directory: [
+        [?d],
+        true
+      ],
+      fps: [
+        [?f],
+        true
+      ],
+      extension: [
+        [?e],
+        true
+      ]
+    },
+    double: {
+      help: [
+        ['help'],
+        false
+      ],
+      directory: [
+        ['base-directory', 'directory', 'dir'],
+        true
+      ],
+      fps: [
+        ['fps'],
+        true
+      ],
+      extension: [
+        ['extension', 'ext'],
+        true
+      ]
+    },
+    keywords: {
+      input: [:INPUT]
+    }
+  }
+  MESSAGE_PADDING        = '  '
+  AUDIO_FILE_REGEX       = /\A[\/\w\-]+?\.(flac|mp3|wav|ogg|mp4|mkv|webm)\z/i
+  BASE_DIRECTORY_REGEX   = /\A[\/\w\-]+\z/
+  PERCENT_DECIMAL_POINTS = 2
+
+  def initialize
+    validate_dependencies
+    @arguments      = ArgumentParser.get_arguments VALID_ARGUMENTS
+    @input_file     = nil
+    @base_directory = nil
+    @fps            = DEFAULTS[:fps]
+    @extension      = DEFAULTS[:extension]
+    handle_arguments
+    validate_arguments
+    @directory = get_directory
+  end
+
+  def run
+    input_file_duration = `ffprobe -show_entries format=duration -v error -of default=noprint_wrappers=1:nokey=1 -i #{@input_file}`.strip.to_f
+    segment_duration    = 1.0 / @fps.to_f
+    segments_amount     = (input_file_duration / segment_duration).ceil
+    segments_amount.times do |n|
+      filename  = "#{n.to_s.rjust 4, ?0}.#{@extension}"
+      seek_time = segment_duration * n
+      cmd       = "ffmpeg -y -ss #{seek_time} -i #{@input_file} -t #{segment_duration} -vn #{@directory}/#{filename} &> /dev/null"
+      n_human   = n + 1
+      percent   = ((n_human.to_f / segments_amount.to_f) * 100.0).round(PERCENT_DECIMAL_POINTS)
+      msg(
+        "Executing:",
+        "`#{cmd}'",
+        "#{n_human}/#{segments_amount} -- #{percent.to_s}% done."
+      )
+      error(
+        "ffmpeg exited with an error code!"
+      )  unless (system cmd)
+    end
+    msg "Done!", "Generated files in #{@directory}."
+  end
+
+  private
+
+    def error *messages
+      message = messages.flatten.join(?\n).gsub(/^/,"#{MESSAGE_PADDING}")
+      abort([
+        "#{$0} ERROR",
+        message,
+        "#{MESSAGE_PADDING}Exiting."
+      ].flatten.join(?\n))
+    end
+
+    def msg *messages
+      message = messages.flatten.join(?\n).gsub(/^/,"#{MESSAGE_PADDING}")
+      puts([
+        "#{$0}",
+        message
+      ].flatten.join(?\n))
+    end
+
+    def validate_dependencies
+      error(
+        "`ffmpeg' is not available."
+      )  unless (system('which ffmpeg &> /dev/null'))
+    end
+
+    def handle_arguments
+      if (@arguments[:options][:help])
+        puts HELP_TEXT
+        exit
+      end
+      @input_file     = (@arguments[:keywords][:input] || []).first
+      @base_directory = @arguments[:options][:directory]   if (@arguments[:options][:directory])
+      @fps            = @arguments[:options][:fps]         if (@arguments[:options][:fps])
+      @extension      = @arguments[:options][:extension]   if (@arguments[:options][:extension])
+    end
+
+    def validate_arguments
+      error(
+        "AUDIO_FILEPATH must be a valid audio or video file.",
+        "It must match `#{AUDIO_FILE_REGEX.inspect}'",
+        "Got `#{@input_file}'."
+      )  unless (valid_audio_file? @input_file)
+      error(
+        "BASE_DIRECTORY must be in a valid parent directory.",
+        "It must match `#{BASE_DIRECTORY_REGEX.inspect}`",
+        "Got `#{@base_directory}'."
+      )  unless (valid_base_directory? @base_directory)
+      # TODO: Validate other options.
+    end
+
+    def valid_audio_file? audio_file
+      return (
+        audio_file             &&
+        File.file?(audio_file) &&
+        audio_file.match?(AUDIO_FILE_REGEX)
+      )
+    end
+
+    def valid_base_directory? base_directory
+      return (
+        base_directory                                &&
+        File.directory?(File.dirname(base_directory)) &&
+        base_directory.match?(BASE_DIRECTORY_REGEX)
+      )
+    end
+
+    def get_directory
+      directory = "#{@base_directory}.#{@fps.to_s}F.#{@extension}"
+      Dir.mkdir directory  unless (File.directory? directory)
+      return directory
+    end
+end
+
+if ($0 == __FILE__)
+  generator = AudioGenerator.new
+  generator.run
+end

data/bin/mkclip

@@ -0,0 +1,223 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'argument_parser'
+
+class ImageGenerator
+  DEFAULTS = {
+    resolution: '960x540',
+    fps:        24,
+    extension:  'png',
+    quality:    5
+  }
+  HELP_TEXT = <<-EOT
+  USAGE
+    #{$0} [options...] VIDEO_FILEPATH
+
+  VIDEO_FILEPATH
+    The path to a video file.
+    This argument is mandatory.
+
+  OPTIONS
+    --help, -h
+      Print this text and exit.
+
+    --base-directory, --directory, --dir, -d BASE_DIRECTORY
+      The path and base name of the directory
+      where the files will be put. The full directory
+      name will be created with the following format:
+        {BASE_DIRECTORY}.{RESOLUTION}.{FPS}F.{EXTENSION}
+          If the EXTENSION is a JPEG format, then the QUALITY will be included:
+        {BASE_DIRECTORY}.{RESOLUTION}.{FPS}F.{QUALITY}Q.{EXTENSION}
+      This option is mandatory.
+
+    --resolution, --res, -r RESOLUTION
+      The resolution to use for the images.
+      The images will be scaled to fit the resolution.
+      See `$ man ffmpeg' for formatting options.
+      Default: '#{DEFAULTS[:resolution]}'
+
+    --fps, -f FPS
+      The frames per second to use, as an integer.
+      Default: '#{DEFAULTS[:fps]}'
+
+    --extension, --ext, -e EXTENSION
+      The extension and image format to use for the images.
+      Default: '#{DEFAULTS[:extension]}'
+
+    --quality, -q QUALITY
+      The quality to use for JPEG compression, as an integer.
+      The higher the value is, the better the quality is.
+      This will only have an effect on compression formats that take a quality option.
+      Default: '#{DEFAULTS[:quality]}'
+  EOT
+  VALID_ARGUMENTS = {
+    single: {
+      help: [
+        [?h],
+        false
+      ],
+      directory: [
+        [?d],
+        true
+      ],
+      resolution: [
+        [?r],
+        true
+      ],
+      fps: [
+        [?f],
+        true
+      ],
+      extension: [
+        [?e],
+        true
+      ],
+      quality: [
+        [?q],
+        true
+      ]
+    },
+    double: {
+      help: [
+        ['help'],
+        false
+      ],
+      directory: [
+        ['base-directory', 'directory', 'dir'],
+        true
+      ],
+      resolution: [
+        ['resolution', 'res'],
+        true
+      ],
+      fps: [
+        ['fps'],
+        true
+      ],
+      extension: [
+        ['extension', 'ext'],
+        true
+      ],
+      quality: [
+        ['quality'],
+        true
+      ]
+    },
+    keywords: {
+      input: [:INPUT]
+    }
+  }
+  MESSAGE_PADDING        = '  '
+  VIDEO_FILE_REGEX     = /\A[\/\w\-]+?\.(mp4|mkv|webm)\z/i
+  BASE_DIRECTORY_REGEX = /\A[\/\w\-]+\z/
+
+  def initialize
+    validate_dependencies
+    @arguments      = ArgumentParser.get_arguments VALID_ARGUMENTS
+    @input_file     = nil
+    @base_directory = nil
+    @resolution     = DEFAULTS[:resolution]
+    @fps            = DEFAULTS[:fps]
+    @extension      = DEFAULTS[:extension]
+    @quality        = DEFAULTS[:quality]
+    handle_arguments
+    validate_arguments
+    @directory = get_directory
+  end
+
+  def run
+    cmd = "ffmpeg -y -i #{@input_file} -filter:v scale=#{@resolution} -r #{@fps} -qscale:v #{@quality} -an #{@directory}/%4d.#{@extension}"
+    msg(
+      "Executing:",
+      "`#{cmd}'"
+    )
+    error(
+      "ffmpeg exited with an error code!"
+    )  unless (system cmd)
+    msg "Done!", "Generated files in #{@directory}."
+  end
+
+  private
+
+    def error *messages
+      message = messages.flatten.join(?\n).gsub(/^/,"#{MESSAGE_PADDING}")
+      abort([
+        "#{$0} ERROR",
+        message,
+        "#{MESSAGE_PADDING}Exiting."
+      ].flatten.join(?\n))
+    end
+
+    def msg *messages
+      message = messages.flatten.join(?\n).gsub(/^/,"#{MESSAGE_PADDING}")
+      puts([
+        "#{$0}",
+        message
+      ].flatten.join(?\n))
+    end
+
+    def validate_dependencies
+      error(
+        "`ffmpeg' is not available."
+      )  unless (system('which ffmpeg &> /dev/null'))
+    end
+
+    def handle_arguments
+      if (@arguments[:options][:help])
+        puts HELP_TEXT
+        exit
+      end
+      @input_file     = (@arguments[:keywords][:input] || []).first
+      @base_directory = @arguments[:options][:directory]   if (@arguments[:options][:directory])
+      @resolution     = @arguments[:options][:resolution]  if (@arguments[:options][:resolution])
+      @fps            = @arguments[:options][:fps]         if (@arguments[:options][:fps])
+      @extension      = @arguments[:options][:extension]   if (@arguments[:options][:extension])
+      @quality        = @arguments[:options][:quality]     if (@arguments[:options][:quality])
+    end
+
+    def validate_arguments
+      error(
+        "VIDEO_FILEPATH must be a valid video file.",
+        "It must match `#{VIDEO_FILE_REGEX.inspect}'",
+        "Got `#{@input_file}'."
+      )  unless (valid_video_file? @input_file)
+      error(
+        "BASE_DIRECTORY must be in a valid parent directory.",
+        "It must match `#{BASE_DIRECTORY_REGEX.inspect}`",
+        "Got `#{@base_directory}'."
+      )  unless (valid_base_directory? @base_directory)
+      # TODO: Validate other options.
+    end
+
+    def valid_video_file? video_file
+      return (
+        video_file             &&
+        File.file?(video_file) &&
+        video_file.match?(VIDEO_FILE_REGEX)
+      )
+    end
+
+    def valid_base_directory? base_directory
+      return (
+        base_directory                                &&
+        File.directory?(File.dirname(base_directory)) &&
+        base_directory.match?(BASE_DIRECTORY_REGEX)
+      )
+    end
+
+    def get_directory
+      directory = "#{@base_directory}.#{@resolution}.#{@fps.to_s}F#{is_jpeg? ? ".#{@quality}Q" : ""}.#{@extension}"
+      Dir.mkdir directory  unless (File.directory? directory)
+      return directory
+    end
+
+    def is_jpeg?
+      return @extension.match?(/\Ajpe?g\z/i)
+    end
+end
+
+if ($0 == __FILE__)
+  generator = ImageGenerator.new
+  generator.run
+end

data/bin/rdoc

@@ -0,0 +1,9 @@
+#!/bin/bash
+# Generate rdoc documentation
+
+root="$( dirname "$0" )/.."
+dir="${root}/lib"
+main="${dir}/adventure_rl.rb"
+output_dir="${root}/rdoc"
+
+rdoc --main "$main" --op "$output_dir" $dir

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/vimall

@@ -0,0 +1,5 @@
+#!/usr/bin/bash
+IFS=$'\n'
+files=('./README.md' './bin/*' './default_settings.yml' './adventure_rl.gemspec' './Gemfile' './vimrc' './Rakefile' './.gitignore')
+files_find=($( find . -iname '*.rb' ))
+vim +'source ./vimrc' ${files[@]} ${files_find[@]}