steam_hlds_log_parser 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  data.tar.gz: 07e4b392ab7437fcfdc19b459ed818ef2f9ea568f7bb77790f90aa2225f5bde3c99f28af74684d1ea8fcde0b033fae332a3b9e24401dd20001a055b3eb7cdbe7
-  metadata.gz: 6b3effe39ddd007a2970b3ba3887e031b82042fec141a87d71f288e10f948535a4ba9abd7437a54722472f42f2b00cd59f6cd8622468c1b1a08afd0be591ed62
+  data.tar.gz: 3bc2eb5cc13ade49b5467b27a58ffed3630ffe3121b2bb0bf52dac7b5eb06c1d556ff3bacd8884eb397d0c541d1c6052265f6a3c5cdceb18ce862e3aa5e8e360
+  metadata.gz: 191dd0220f6b60bc2970e2af9c420cbe0d56d4c533d4e8ad8595883cdd28c38fd91ee40ce8bdc531738a46730e0e9c2955cac08e0dc424b8615f204e9091786c
 SHA1: 
-  data.tar.gz: a0df584749432ba49b668243c12eb2fd7f4b0bc0
-  metadata.gz: d9aca93be069273408f47ad57a141f2b9b7bd3b4
+  data.tar.gz: 53510a0ac2927b3e16b2e4739ef057cc1f7d6aed
+  metadata.gz: 047028a751c2032a54fb6ffda1584cf231ef3128

data/README.md

@@ -1,11 +1,10 @@
 # Steam Hlds Log Parser
 
-Creates a server with EventMachine which listens to HLDS logs, parse and returns readable content from your game server.
-The returned content can be sent to a website, IRC or flowdock for match live streaming.
+Steam Hlds Log Parser listens to UDP log packets sent by your (local or remote) HLDS game server, processes data and returns clean or/and translated and readable content that you can use for your website, irc channel, match live streaming, bots, database...
 
-Mostly tested on Steam HLDS for Counter-Strike.
+Should work with all Steam HLDS based games, and has been mostly tested on Counter-Strike 1.6.
 
-Note : content is sent in english or french at this time. Need i18n contributors!
+Note : translated content is sent in english or french at this time. Need i18n contributors!
 
 ## Build Status
 
@@ -27,12 +26,14 @@ Or install it yourself as:
 
     $ gem install steam_hlds_log_parser
 
-## Usage
+## Configuration
 
 1. Create your own displayer callback `class` which will receive parsed data
 Ask this `class` to write a file, send content to IRC or flowdock... whatever... and give it as `:displayer` Hash option
 2. Create a new client on desired IP / Port / Options
-3. In your HLDS server: `logaddress 127.0.0.1 27035`  
+3. Of course, you need to have server RCON. In your `server.cfg` (or in server console) add `logaddress 127.0.0.1 27035`. It specifies where the logs will be sent. This must be the IP / Port your ruby client will listen to.
+
+If you are behind a router/firewall, you probably need to configure it.
 
 ## Example
 
@@ -59,6 +60,16 @@ Ask this `class` to write a file, send content to IRC or flowdock... whatever...
     parser = SteamHldsLogParser::Client.new("127.0.0.1", 27035, options)
     parser.start
 
+## Documentation
+
+Steam HLDS Log Parser should be 100% documented.
+However, if you find something to improve, feel free to contribute.
+Full documentation can be found on [Steam HLDS Parser Log page on Rubydoc](http://rubydoc.info/gems/steam_hlds_log_parser).
+
+## Tests
+
+Steam HLDS Log Parser uses RSpec as test / specification framework and should be 100% tested too.
+Here again, feel free to improve it.
 
 ## Contributing
 

data/lib/steam_hlds_log_parser/client.rb

@@ -1,6 +1,10 @@
 module SteamHldsLogParser
 
   # Listens to HLDS logs received via UDP on configured port
+  #
+  # @attr_reader [String] host Client host / IP
+  # @attr_reader [Integer] port Client port to listen to
+  # @attr_reader [Hash] options Client options
   class Client
 
     attr_reader :host, :port, :options
@@ -8,8 +12,8 @@ module SteamHldsLogParser
     # Creates a new client 
     #
     # @param [String] host Hostname / IP Address the server will be running
-    # @param [Integer] port Port to listen to
-    # @param [Hash] options Other options
+    # @param [Integer] port Port will be listening to
+    # @param [Hash] options Other configuration options
     #
     # @option options [Symbol] :locale (:en) Set the language of returned content
     # @option options [Boolean] :display_kills (true) Enable kills / frags detail 

data/lib/steam_hlds_log_parser/handler.rb

@@ -1,15 +1,19 @@
 module SteamHldsLogParser
 
   # Process data received by 'Client'
+  #
+  # @attr_reader [String] host Client host / IP
+  # @attr_reader [Integer] port Client port to listen to
+  # @attr_reader [Hash] options Client options
   class Handler < EM::Connection
 
     attr_reader :host, :port, :options
 
     # Initialize Handler from Client options
     #
-    # @param [String] host Hostname / IP Address the server will be running
-    # @param [Integer] port Port to listen to
-    # @param [Hash] options Other options
+    # @param [String] host Hostname / IP Address the server is running
+    # @param [Integer] port Port is listening to
+    # @param [Hash] options Other client configuration options
     #
     def initialize(host, port, options)
       @host, @port, @options = host, port, options

data/lib/steam_hlds_log_parser/version.rb

@@ -1,4 +1,4 @@
 module SteamHldsLogParser
   # Gem Version
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: steam_hlds_log_parser
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Thomas VIAL
@@ -100,9 +100,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- example/example-1.rb
-- example/example-2.rb
-- lib/.DS_Store
+- examples/example-1.rb
+- examples/example-2.rb
 - lib/locales/en.yml
 - lib/locales/fr.yml
 - lib/steam_hlds_log_parser.rb