roguelike 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1dea25c16631fd6fd93b1ce963282001de3c5abb
+  data.tar.gz: 25446f9a50f691abf2ea4cbde61956b77707b352
+SHA512:
+  metadata.gz: a20737781fc49df384ce5453c2e8e8859f1ed1c247d97e7d9409cacb776e9ed587a79535d74b01b56911df7025d9137ad42d45a7bf6d090cc3170a7381530ddc
+  data.tar.gz: e765ed468e71d48045912b741b7a725684740680bfeed67f8ce7b0ccec324c4c5319b2ebad61e309b41dae0d7c9909eca3597d286dc627fc621f8da4cbedf869

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+dev_map.yaml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'commander'

data/Gemfile.lock

@@ -0,0 +1,15 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.3.4)
+      highline (~> 1.7.2)
+    highline (1.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  commander
+
+BUNDLED WITH
+   1.10.3

data/README.md

@@ -0,0 +1,79 @@
+[![Gem Version](https://badge.fury.io/rb/roguelike.svg)](http://badge.fury.io/rb/roguelike)
+
+# Roguelike
+
+A Rogue cloning engine written in Ruby
+
+Roguelike is intended to be a full engine capable of running clones of the 1980 game [Rogue](https://en.wikipedia.org/wiki/Rogue_(video_game)). Users will eventually be able to simply provide a series of maps they've created and Roguelike will handle all of the logic of the game. In this way, someone who wants to create their own version of Rogue simply needs to design their dungeons, layout the enemies and treasures, and let Roguelike do the rest.
+
+## Usage
+
+Using Roguelike is relatively simple. In order to create your own clone of Rogue, all you need to do is create a YAML file containing all of the necessary information for the game to run.
+
+### map.yaml
+
+Your YAML file should contain a list of rooms (or levels) for your game, each with the following information:
+
+Data | Description
+-----|-------------
+number | The number of the room, which will determine the order in which the rooms are visited
+initial_x | An integer representing the x coordinate at which the player character should be drawn upon entering the room
+initial_y | An integer representing the y coordinate at which the player character should be drawn upon entering the room
+layout | A visual representation in ASCII characters of the room's layout
+
+When drawing the layout, the following characters should be used to represent various parts of the map:
+
+Character   | What it Represents
+------------|-------------------
+`|` and `-` | Walls, which the player cannot pass through
+`#`         | Doors/stairs, which will lead the player to the next room
+
+There will be more characters available to represent other elements, such as enemies, traps, or treasure further in development. The player's character will be rendered as the `@` character based on the coordinates designed in the YAML file.
+
+For an example of how your YAML file should be constructed, look at [example_map.yaml](https://github.com/chrisccerami/roguelike/blob/master/map_example.yaml)
+
+Once your map is complete, you can start the program using the command:
+
+```shell
+$ roguelike run my_map.yaml
+```
+
+This will read your YAML file and start the game.
+
+## Contributing
+
+If you would like to contribute to Roguelike, feel free to create a
+pull request. If you'd like to contact me, you can reach me at
+[chrisccerami@gmail.com](mailto:chrisccerami@gmail.com) or on
+Twitter [@chrisccerami](https://twitter.com/chrisccerami).
+
+1. Fork it ( https://github.com/chrisccerami/roguelike/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+Copyright (c) 2015 Chris C Cerami
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,14 @@
+require "rspec/core/rake_task"
+require "./lib/roguelike"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "irb -r ascii_art -I ./lib"
+end
+
+task :run do
+  Roguelike.run("./map.yaml")
+end

data/bin/roguelike

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'commander/import'
+require 'roguelike'
+require 'roguelike/version'
+
+program :version, Roguelike::VERSION
+program :description, 'A generator for Rogue clones using levels designed in YAML'
+command :run do |c|
+  c.syntax = 'roguelike run [options]'
+  c.summary = 'Create Rogue clones using levels designed in YAML'
+  c.description = "Roguelike will read your game's YAML file, create levels based on your designs, and then handle all of the logic of building and running a customized Rogue clone for you."
+  c.example 'Run your new Rogue clone', 'roguelike run my_levels.yaml'
+  c.action do |args, options|
+    Roguelike.run(args.first)
+  end
+end
+

data/lib/roguelike.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift './lib/roguelike'
+
+module Roguelike
+  require 'curses'
+  require 'ui'
+  require 'game'
+  require 'map'
+  require 'character'
+  require 'yaml'
+
+  def self.run(map_name)
+    Game.instance.run(map_name)
+  end
+end

data/lib/roguelike/character.rb

@@ -0,0 +1,49 @@
+class Character
+  attr_accessor :avatar, :x_pos, :y_pos
+  def initialize(avatar, x, y)
+    @avatar = avatar
+    @x_pos = x
+    @y_pos = y
+  end
+
+  def move(x, y)
+    if can_move?(x, y)
+      UI.instance.clear_position(@x_pos, @y_pos)
+      @x_pos = x
+      @y_pos = y
+      check_target(x, y)
+    else
+      UI.instance.alert_user
+    end
+  end
+
+  def move_up
+    move(@x_pos, @y_pos - 1)
+  end
+
+  def move_down
+    move(@x_pos, @y_pos + 1)
+  end
+
+  def move_left
+    move(@x_pos - 1, @y_pos)
+  end
+
+  def move_right
+    move(@x_pos + 1, @y_pos)
+  end
+
+  def can_move?(target_x, target_y)
+    !UI.instance.wall?(target_x, target_y)
+  end
+
+  def check_target(x, y)
+    if UI.instance.door?(x, y)
+      move_through_door
+    end
+  end
+
+  def move_through_door
+    UI.instance.next_room
+  end
+end

data/lib/roguelike/game.rb

@@ -0,0 +1,40 @@
+class Game
+  include Singleton
+
+  attr_reader :ui, :character
+  attr_accessor :map, :map_name
+  def initialize
+    @map
+    @ui = UI.instance
+    @character = Character.new("@", nil, nil)
+  end
+
+  def run(map_name)
+    self.map = Map.new(map_name, 1)
+    set_character_position
+    ui.write(0, 0, map.layout)
+    ui.write(character.x_pos, character.y_pos, character.avatar)
+    loop do
+      accept_input
+    end
+  end
+
+  private
+
+  def set_character_position
+    character.x_pos = @map.initial_x
+    character.y_pos = @map.initial_y
+  end
+
+  def accept_input
+    inputs = {
+      w: proc { character.move_up },
+      a: proc { character.move_left },
+      s: proc { character.move_down },
+      d: proc { character.move_right },
+      q: proc { ui.close }
+    }
+    inputs[ui.accept_input.to_sym].call
+    ui.write(character.x_pos, character.y_pos, character.avatar)
+  end
+end

data/lib/roguelike/map.rb

@@ -0,0 +1,29 @@
+class Map
+  require 'yaml'
+
+  attr_reader :file
+  attr_accessor :layout, :number, :initial_x, :initial_y
+  def initialize(file_name, number)
+    @file = YAML.load_file(file_name)
+    map = Map.find_map(@file, number)
+    @number = number
+    @layout = map["layout"]
+    @initial_x = map["initial_x"]
+    @initial_y = map["initial_y"]
+  end
+
+  def update_map(number)
+    map = Map.find_map(self.file, number)
+    @number = number
+    @layout = map["layout"]
+    @initial_x = map["initial_x"]
+    @initial_y = map["initial_y"]
+  end
+
+  private
+
+  def self.find_map(file, n)
+    file.select { |map| map["number"] == n }.first
+  end
+
+end

data/lib/roguelike/ui.rb

@@ -0,0 +1,62 @@
+class UI
+  include Curses
+  require 'singleton'
+  include Singleton
+
+  def initialize
+    noecho
+    curs_set(0)
+    init_screen
+  end
+
+  def close
+    close_screen
+    exit
+  end
+
+  def write(x, y, string)
+    setpos(y, x)
+    addstr(string)
+  end
+
+  def accept_input
+    inputs = %w(w a s d q)
+    loop do
+      input = getch
+      return input if inputs.include?(input)
+    end
+  end
+
+  def clear_position(x, y)
+    setpos(y, x)
+    delch
+    insch(' ')
+  end
+
+  def wall?(x, y)
+    setpos(y, x)
+    inch.chr == '|' || inch.chr == '-'
+  end
+
+  def door?(x, y)
+    setpos(y, x)
+    inch.chr =='#'
+  end
+
+  def alert_user
+    beep
+    flash
+  end
+
+  def load_room(map)
+    write(0, 0, map.layout)
+    Game.instance.character.move(map.initial_x, map.initial_y)
+  end
+
+  def next_room
+    clear
+    next_room = Game.instance.map.number + 1
+    Game.instance.map.update_map(next_room)
+    load_room(Game.instance.map)
+  end
+end

data/lib/roguelike/version.rb

@@ -0,0 +1,3 @@
+module Roguelike
+  VERSION = "0.0.2"
+end

data/map_example.yaml

@@ -0,0 +1,77 @@
+---
+- number: 1
+  initial_x: 1
+  initial_y: 2
+  layout: >
+    ----------------------------------------------
+       |        |                 |              |
+       |        |                 |              |
+    -  -  ----  -  -------------  -  ----------  -
+
+    |        |  |     |        |  |           |  |
+
+    |        |  |     |        |  |           |  |
+
+    ----------  -  ----  -------  ----------  -  -
+
+    |     |     |  |        |     |     |     |  |
+
+    |     |     |  |        |     |     |     |  |
+
+    -  ----  ----  -  -  ----  ----  ----  ----  -
+
+    |        |     |  |        |           |     |
+
+    |     #  |     |  |        |           |     |
+
+    -  -------  ----  ----  ----  ----------  ----
+
+    |     |  |  |  |     |  |        |     |     |
+
+    |     |  |  |  |     |  |        |     |     |
+
+    -  -  -  -  -  ----  -  -  ----  -  -  ----  -
+
+    |  |     |  |     |  |     |     |  |     |  |
+
+    |  |     |  |     |  |     |     |  |     |  |
+
+    -  -------  -  ----  ----  -  ----------  -  -
+
+    |        |     |     |     |              |  |
+
+    |        |     |     |     |              |  |
+
+    -------  -------  ----  -------------------  -
+
+    |        |     |  |           |        |     |
+
+    |        |     |  |           |        |     |
+
+    -  -------  -  -  ----------  -  ----  -  -  -
+
+    |           |     |     |     |     |  |  |  |
+
+    |           |     |     |     |     |  |  |  |
+
+    -------  ----------  -  -  -  ----  ----  -  -
+
+    |        |           |     |     |        |  |
+
+    |        |           |     |     |        |  |
+
+    ----------------------------------------------
+
+- number: 2
+  initial_x: 1
+  initial_y: 1
+  layout: >
+    --------------------
+
+    |                   |
+
+    |                   |
+
+    |                 # |
+
+    ---------------------

data/roguelike.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roguelike/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "roguelike"
+  spec.version       = Roguelike::VERSION
+  spec.authors       = ["Chris C Cerami"]
+  spec.email         = ["chrisccerami@gmail.com"]
+  spec.date          = '2015-07-26'
+  spec.summary       = "Create Rogue clones using levels designed in YAML"
+  spec.description   = "Roguelike will read your game's YAML file, create levels based on your designs, and then handle all of the logic of building and running a customized Rogue clone for you."
+  spec.homepage      = "http://rubygems.org/gems/roguelike"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path  = "lib"
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_runtime_dependency 'commander', '~> 4.3'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: roguelike
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Chris C Cerami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-26 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: Roguelike will read your game's YAML file, create levels based on your
+  designs, and then handle all of the logic of building and running a customized Rogue
+  clone for you.
+email:
+- chrisccerami@gmail.com
+executables:
+- roguelike
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/roguelike
+- lib/roguelike.rb
+- lib/roguelike/character.rb
+- lib/roguelike/game.rb
+- lib/roguelike/map.rb
+- lib/roguelike/ui.rb
+- lib/roguelike/version.rb
+- map_example.yaml
+- roguelike.gemspec
+homepage: http://rubygems.org/gems/roguelike
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Create Rogue clones using levels designed in YAML
+test_files: []