minecraft-server 0.0.1.pre.43 → 0.0.1.pre.44

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDc5YzAwNTI4YzJjNTc4MTE2NGEwMDg3NjA2NjRhMmEwZTQ0ZDg4MQ==
+    MDU4ODEwZjI3NTY5MzhlOGY0NGZlZWZkODZlZDAzNTAyYWY3ZmFiYQ==
   data.tar.gz: !binary |-
-    OThlOGEyMTFiZmM1YjcwYWM3MDk5NjdlYjVhN2U5ZTY5N2JlZTYyNw==
+    N2ExMWMwMGNhODI2MDE2YWJiNDdkNzQ0YmU5NmQwMmQ5ZDQyNWE5Zg==
 SHA512:
   metadata.gz: !binary |-
-    Y2JhYTEyYjMxZDE3NDM1YWFlNDAwYzJjNjNjMTFjNjgyNzA0YjcyZGQzNjVl
-    NjUwMDBhOGUzMmYzYjIyMjJjOGU5ZTBmN2Y2MjNiZWZlODRhNmQzOTU1ZTQ5
-    MTMyMmVjMzNhOTA4OTNjNDU2YTJhYzFkMzgyNDdjOTM3Y2I4Mzg=
+    M2U1Mzg5ZGZlODZlY2M5ZjFlNmM4ODEwMDA3MTk2NjgxMmM1NTg2ODc1MjA0
+    ZDFkM2FiYjM2NmQ3NDU3YzA5ZTg5ODM1NGEzODdmMTNlMWJhZTEzNDQzYTVj
+    NDRhYjkxMGJhNmUxMmRmOWQzZmIxZjE1ZmQyM2IyZmU5YWVlNWM=
   data.tar.gz: !binary |-
-    MTZkNTEzNmYwZjU1NmRhZDY4M2Y2Y2IzYTVkNjAwYWY2OTdiYzA4MWI5YTQw
-    NjI3YzZiYWYwYTNiY2E1YWI0N2VlYjgxOTg5OWQ4OThhMWIxYzRhNjU4N2Mz
-    YmZkNmE5MDZiNDczZWQ2ZmE1ZDAyZTJkMGY3YTZiZDhiODZjNTA=
+    Y2UyYjE3MWFkZjJiNmFiM2JmMTBmZjY4YTZhMjE2ODliYmJhZjFhYmNmMWE4
+    Zjg4ODU2N2Q2NTkwNjYyYmJiZTA3ZjI5MzllNGRhNDUyMDI1YjFjOTJmNTEz
+    ODZjZGZhYmRkYTdiNzJlNWQxM2MyNmY2MTJhNmEwMTVkN2VkMjQ=

data/lib/minecraft/server.rb

@@ -4,25 +4,31 @@ require 'minecraft/server/logger'
 require 'minecraft/server/version'
 
 module Minecraft
+  # Control Center of the Minecraft Server.
+  # Can be run from this class, although not advised. If you wish to run a Minecraft Server proper please use executables
+  # included in the gem.
   class Server
-    # @!attribute server
+    # @!attribute [r] server
     #   Instance variable representing the current instance of {TCPServer} this instance of {Minecraft::Server} is
     #   currently using for network communication.
     #   @return [TCPServer] The TCP Server used for network communication
-    attr_reader :server
-
-    # @!attribute clients
+    # @!attribute [r] clients
     #   Instance variable representing the Array of Clients Currently Connected.
     #   @return [Array] The clients connected
-    attr_reader :clients
+    # @!attribute [r] config
+    #   Instance variable representing the configuration currently being used by the server.
+    #   This should be defined using the DSL from {Minecraft::Server::Config}.
+    #   @return [Hash] The configuration values
+    attr_reader :server, :clients, :config
 
     # @!attribute logger
     #   Instance variable representing the Logger being used.
     #   @return [Log4r::Logger]
     attr_accessor :logger
 
-    attr_reader :config
-
+    # Sets up the instance of the server so that everything will function.
+    # Creates an appropriate logger and sets starts API detection and configuration.
+    # @param config [Hash] Contains the information for creating a new server, should be created using {Minecraft::Server::Configuration}
     def initialize(config = {})
       @logger = Minecraft::Server::Logger.new
       @config = config
@@ -35,6 +41,7 @@ module Minecraft
       logger.info "Running on port: #{config[:port]}"
     end
 
+    # If Bukkit API is enabled will configure server for use with API.
     def bukkit_api
       if config[:bukkit]
         require 'bukkit/server'
@@ -45,6 +52,7 @@ module Minecraft
       end
     end
 
+    # If the Minecraft Forge API is enabled will configure server for use with API.
     def minecraft_forge_api
       if config[:minecraft_forge]
         # self.extend Minecraft::Forge::Server
@@ -54,6 +62,7 @@ module Minecraft
       end
     end
 
+    # If the Spigot API is enabled will configure server for use with API.
     def spigot_api
       if config[:spigot]
         # self.extend Spigot::Server
@@ -63,6 +72,7 @@ module Minecraft
       end
     end
 
+    # If the Sponge API is enabled will configure server for use with API.
     def sponge_api
       if config[:sponge]
         # self.extend Sponge::Server
@@ -80,6 +90,7 @@ module Minecraft
       accept_clients
     end
 
+    # Starts a new loop in a new thread to accept new clients.
     def accept_clients
       Thread.new do
         loop do
@@ -91,6 +102,7 @@ module Minecraft
       end.join
     end
 
+    # Drops all currently connected clients.
     def drop_clients
       logger.info 'Now Dropping all Recorded Clients'
       clients.each do |client|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minecraft-server
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.43
+  version: 0.0.1.pre.44
 platform: ruby
 authors:
 - Kepler Sticka-Jones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-27 00:00:00.000000000 Z
+date: 2014-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor