twitch_plays 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59c3c777cdfd0a165cb02b9989c99e11fc393235
-  data.tar.gz: 0fe695162142a9206d2c704d2ddef4b1fdcc7ca9
+  metadata.gz: 7f5eff287aae3d3f6221c28b55737e048175a81c
+  data.tar.gz: 599ed21f42926111ac564d491bb9ebbab2a781f5
 SHA512:
-  metadata.gz: 6d23154385b836e69d92fa9a912226fc3733e69488c402ed113b3c55e7909fb852afc728396d4e7ffb08973a467cd18be53ea26842b430e67554479d412ad305
-  data.tar.gz: c4ed7029795388bb91df1422b137d7694093327695213b4036264895500136625893dd93d02723d8e2bd7259002acd4306e1a89850370e46ba791e4a1ab416e3
+  metadata.gz: 8db97deb045cbe09dc0e1eecea0b0747034d1c0eec1f2d86b505d86a91649454b25a12a24e2ddd4c1875bbffc9cbe168b35c01faf510b1ab24cce1ae6c24b0f8
+  data.tar.gz: 80e19829f0c751bb97d2094cbc1fae45c8df52fbbaf4cfff29f2f9a1976dc69792f96ce01fc6129a36a98c21b89f6a5670afbffa1fd13aa108f7fa5e1aaa2cd2

data/README.md

@@ -3,6 +3,12 @@ twitch_plays
 
 Yet another Twitch Plays Pokemon clone. MMO-ify any game over IRC.
 
+Prerequisites
+-------------
+
+Requires xdotool on Linux.
+
+
 Configuration
 -------------
 

data/config.yml

@@ -1,11 +1,13 @@
 # CONNECTION INFO
-:nick: TwitchPlaysSomething # same as Twitch username
-:password: # get one at http://twitchapps.com/tmi/
+:nick: twitchplaysbot # Twitch username in all lowercase
+:password: # Get one at http://twitchapps.com/tmi/
 :server: irc.twitch.tv
 :port: 6667
-:channel: '#TwitchPlaysSomething' # Twitch channel to listen on
+:channel: '#twitchplaysbot' # Twitch channel to listen on, all lowercase
 
 :log_line_length: 35 # Enough to fit a twitch username, a space, and "democracy"
+:use_touch: true
+:touch_move_amount: 50 # How many pixels to move the mouse when a touchscreen move is performed
 
 # KEYMAP
 # key names are as in X's keysymdef.h, without the leading XK_
@@ -15,14 +17,14 @@
   :down: Down
   :left: Left
   :right: Right
-  :a: c
-  :b: x
+  :a: d
+  :b: c
   :x: s
   :y: x
   :l: z
   :r: a
   :start: Return
-  :select: space
+  :select: Tab
   :save_state: F1
 
 # DEMOCRACY

data/lib/twitch_plays/os/win.rb

@@ -0,0 +1,151 @@
+require 'ffi'
+
+module TwitchPlays
+  module OS
+    module Win
+      module User32
+        extend FFI::Library
+
+        INPUT_MOUSE = 0x00
+        INPUT_KEYBOARD = 0x01
+
+        MOUSEEVENTF_MOVE = 0x01
+        MOUSEEVENTF_LEFTDOWN = 0x02
+        MOUSEEVENTF_LEFTUP = 0x04
+
+        VK_BACK = 0x08
+        VK_TAB = 0x09
+        VK_RETURN = 0x0d
+        VK_SHIFT = 0x10
+        VK_CONTROL = 0x11
+        VK_SPACE = 0x20
+        VK_LEFT = 0x25
+        VK_UP = 0x26
+        VK_RIGHT = 0x27
+        VK_DOWN = 0x28
+        VK_F1 = 0x70
+        VK_F2 = 0x71
+        VK_F3 = 0x72
+        VK_F4 = 0x73
+        VK_F5 = 0x74
+        VK_F6 = 0x75
+        VK_F7 = 0x76
+        VK_F8 = 0x77
+        VK_F9 = 0x78
+        VK_F10 = 0x79
+        VK_F11 = 0x7a
+        VK_F12 = 0x7b
+
+        class MouseInput < FFI::Struct
+          layout(:dx, :long,
+                 :dy, :long,
+                 :mouse_data, :uint,
+                 :flags, :uint,
+                 :time, :uint,
+                 :extra_info, :pointer)
+        end
+
+        class KeyboardInput < FFI::Struct
+          layout(:vk, :ushort,
+                 :scan, :ushort,
+                 :flags, :uint,
+                 :time, :uint,
+                 :extra_info, :pointer)
+        end
+
+        class InputEvent < FFI::Union
+          layout(:mi, MouseInput,
+                 :ki, KeyboardInput)
+        end
+
+        class Input < FFI::Struct
+          layout(:type, :uint,
+                 :evt, InputEvent)
+        end
+
+        ffi_lib 'user32'
+        ffi_convention :stdcall
+
+        attach_function :SendInput, [:uint, :pointer, :int], :uint
+      end
+
+      TRANSLATE_KEYS = {
+        'BackSpace' => User32::VK_BACK,
+        'Tab' => User32::VK_TAB,
+        'Return' => User32::VK_RETURN,
+        'Shift_L' => User32::VK_SHIFT,
+        'Shift_R' => User32::VK_SHIFT,
+        'Control_L' => User32::VK_CONTROL,
+        'Control_R' => User32::VK_CONTROL,
+        'space' => User32::VK_SPACE,
+        'Left' => User32::VK_LEFT,
+        'Up' => User32::VK_UP,
+        'Right' => User32::VK_RIGHT,
+        'Down' => User32::VK_DOWN,
+        'F1' => User32::VK_F1,
+        'F2' => User32::VK_F2,
+        'F3' => User32::VK_F3,
+        'F4' => User32::VK_F4,
+        'F5' => User32::VK_F5,
+        'F6' => User32::VK_F6,
+        'F7' => User32::VK_F7,
+        'F8' => User32::VK_F8,
+        'F9' => User32::VK_F9,
+        'F10' => User32::VK_F10,
+        'F11' => User32::VK_F11,
+        'F12' => User32::VK_F12
+      }
+
+      def self.press(key)
+        input = User32::Input.new
+        input[:type] = User32::INPUT_KEYBOARD
+        evt = input[:evt][:ki]
+        evt[:vk] = TRANSLATE_KEYS[key] || key.upcase.ord
+        evt[:scan] = 0
+        evt[:flags] = 0
+        evt[:time] = 0
+        evt[:extra_info] = 0
+        User32.SendInput(1, [input], User32::Input.size)
+      end
+
+      def self.touch_move(dx, dy)
+        input = User32::Input.new
+        input[:type] = User32::INPUT_MOUSE
+        evt = input[:evt][:mi]
+        evt[:dx] = dx
+        evt[:dy] = dy
+        evt[:mouse_data] = 0
+        evt[:flags] = User32::MOUSEEVENTF_MOVE
+        evt[:time] = 0
+        evt[:extra_info] = 0
+        User32.SendInput(1, [input], User32::Input.size)
+      end
+
+      def self.touch_press
+        input = User32::Input.new
+        input[:type] = User32::INPUT_MOUSE
+        evt = input[:evt][:mi]
+        evt[:dx] = 0
+        evt[:dy] = 0
+        evt[:mouse_data] = 0
+        evt[:flags] = User32::MOUSEEVENTF_LEFTDOWN
+        evt[:time] = 0
+        evt[:extra_info] = 0
+        User32.SendInput(1, [input], User32::Input.size)
+      end
+
+      def self.touch_release
+        input = User32::Input.new
+        input[:type] = User32::INPUT_MOUSE
+        evt = input[:evt][:mi]
+        evt[:dx] = 0
+        evt[:dy] = 0
+        evt[:mouse_data] = 0
+        evt[:flags] = User32::MOUSEEVENTF_LEFTUP
+        evt[:time] = 0
+        evt[:extra_info] = 0
+        User32.SendInput(1, [input], User32::Input.size)
+      end
+    end
+  end
+end

data/lib/twitch_plays/os/x11.rb

@@ -0,0 +1,21 @@
+module TwitchPlays
+  module OS
+    module X11
+      def self.press(key)
+        `xdotool key #{key}`
+      end
+
+      def self.touch_move(dx, dy)
+        `xdotool mousemove_relative --sync -- #{dx} #{dy}`
+      end
+
+      def self.touch_press
+        `xdotool mousedown 1`
+      end
+
+      def self.touch_release
+        `xdotool mouseup 1`
+      end
+    end
+  end
+end

data/lib/twitch_plays/os.rb

@@ -0,0 +1,10 @@
+module TwitchPlays
+  case RbConfig::CONFIG['host_os']
+  when /win/
+    require_relative 'os/win'
+    Output = OS::Win
+  when /linux/
+    require_relative 'os/x11'
+    Output = OS::X11
+  end
+end

data/lib/twitch_plays/twitch_plays.rb

@@ -1,100 +1,30 @@
+require_relative 'os'
 require 'yaml'
-require 'ffi' if RbConfig::CONFIG['host_os'] =~ /win/
 require 'cinch'
 
 module TwitchPlays
-  if RbConfig::CONFIG['host_os'] =~ /win/
-    module Win
-      extend FFI::Library
-
-      INPUT_KEYBOARD = 1
-
-      VK_BACK = 0x08
-      VK_TAB = 0x09
-      VK_RETURN = 0x0d
-      VK_SHIFT = 0x10
-      VK_CONTROL = 0x11
-      VK_SPACE = 0x20
-      VK_LEFT = 0x25
-      VK_UP = 0x26
-      VK_RIGHT = 0x27
-      VK_DOWN = 0x28
-      VK_F1 = 0x70
-      VK_F2 = 0x71
-      VK_F3 = 0x72
-      VK_F4 = 0x73
-      VK_F5 = 0x74
-      VK_F6 = 0x75
-      VK_F7 = 0x76
-      VK_F8 = 0x77
-      VK_F9 = 0x78
-      VK_F10 = 0x79
-      VK_F11 = 0x7a
-      VK_F12 = 0x7b
-
-      class KeyboardInput < FFI::Struct
-        layout(:vk, :ushort,
-               :scan, :ushort,
-               :flags, :uint,
-               :time, :uint,
-               :extra_info, :pointer)
-      end
-
-      class InputEvent < FFI::Union
-        layout :ki, KeyboardInput
-
-        class Input < FFI::Struct
-          layout(:type, :uint,
-                 :evt, InputEvent)
-        end
-
-        ffi_lib 'user32'
-        ffi_convention :stdcall
-
-        attach_function :SendInput, [:uint, :pointer, :int], :uint
-      end
-    end
-
-    TRANSLATE_KEYS = {
-      'BackSpace' => Win::VK_BACK,
-      'Tab' => Win::VK_TAB,
-      'Return' => Win::VK_RETURN,
-      'Shift_L' => Win::VK_SHIFT,
-      'Shift_R' => Win::VK_SHIFT,
-      'Control_L' => Win::VK_CONTROL,
-      'Control_R' => Win::VK_CONTROL,
-      'space' => Win::VK_SPACE,
-      'Left' => Win::VK_LEFT,
-      'Up' => Win::VK_UP,
-      'Right' => Win::VK_RIGHT,
-      'Down' => Win::VK_DOWN,
-      'F1' => Win::VK_F1,
-      'F2' => Win::VK_F2,
-      'F3' => Win::VK_F3,
-      'F4' => Win::VK_F4,
-      'F5' => Win::VK_F5,
-      'F6' => Win::VK_F6,
-      'F7' => Win::VK_F7,
-      'F8' => Win::VK_F8,
-      'F9' => Win::VK_F9,
-      'F10' => Win::VK_F10,
-      'F11' => Win::VK_F11,
-      'F12' => Win::VK_F12
-    }
-  end
-
   class Plugin
     include Cinch::Plugin
 
+    plugin_name = 'TwitchPlaysPlugin'
     listen_to :connect, method: :on_connect
     listen_to :message, method: :on_message
 
     def initialize(*args)
       super
       @keys = config[:keys]
+      @use_touch = config[:use_touch]
+      touch_move_amount = config[:touch_move_amount]
+      @touch_directions = {
+        touch_up: [0, -touch_move_amount],
+        touch_down: [0, touch_move_amount],
+        touch_left: [-touch_move_amount, 0],
+        touch_right: [touch_move_amount, 0]
+      }
       @democracy_votes = 0
       @anarchy_votes = 0
-      @democracy_mode = config[:start_in_democracy]
+      @use_democracy = config[:use_democracy]
+      @democracy_mode = @use_democracy && config[:start_in_democracy]
       @democracy_ratio_needed = config[:democracy_ratio_needed]
       @anarchy_ratio_needed = config[:anarchy_ratio_needed]
       @button_votes = Hash.new(0)
@@ -113,66 +43,60 @@ module TwitchPlays
     end
 
     def start_democracy
+      return if @democracy_mode
       @democracy_mode = true
       puts '---STARTING DEMOCRACY MODE---'
       @voting_thread = Thread.new do
         while @democracy_mode
-          @button_votes.clear
-          @total_votes = 0
+          synchronize(:votes_mutex) do
+            @button_votes.clear
+            @total_votes = 0
+          end
           sleep @voting_time
-          next if @total_votes == 0
-          out = 'VOTES:'
-          percentages = @button_votes.sort {|(_, count1), (_, count2)|
-            count1 <=> count2
-          }.first(5).map {|(btn, count)|
-            [btn, count.to_f / @total_votes * 100]
-          }.each {|(btn, percent)|
-            out << format_log_line(btn, "#{percent}%")
-          }
-          puts out
-          winner = @button_votes.max_by {|(_, count)| count}
-          next if winner.nil?
-          press(@keys[winner[0]])
+          next if @total_votes.zero?
+          winner = synchronize(:votes_mutex) do
+            puts "VOTES:\n" + @button_votes.sort {|(_, count1), (_, count2)|
+              count1 <=> count2
+            }.first(5).map {|(btn, count)|
+              [btn, count.to_f / @total_votes * 100]
+            }.map {|(btn, percent)|
+              format_log_line(btn, "#{percent}%")
+            }.join("\n")
+            @button_votes.max_by {|(_, count)| count}[0]
+          end
+          case winner
+          when :touch_up, :touch_down, :touch_left, :touch_right
+            Output.touch_move(*@touch_directions[winner])
+          when :touch_press
+            Output.touch_press
+          when :touch_release
+            Output.touch_release
+          else
+            Output.press(@keys[winner])
+          end
         end
       end
     end
 
     def start_anarchy
+      return unless @democracy_mode
       @democracy_mode = false
       @voting_thread.join
+      @voting_thread = nil
       puts '---STARTING ANARCHY MODE---'
     end
 
-    case RbConfig::CONFIG['host_os']
-    when /linux/
-      def press(key)
-        `xdotool key #{key}`
-      end
-    when /win/
-      def press(key)
-        input = Win::Input.new
-        input[:type] = Win::INPUT_KEYBOARD
-        evt = input[:evt][:ki]
-        evt.vk = TRANSLATE_KEYS[key] || key.upcase.ord
-        evt.scan = 0
-        evt.flags = 0
-        evt.time = 0
-        evt.extra_info = 0
-        Win.SendInput(1, [input], Win::Input.size)
-      end
-    end
-
     def format_log_line(name, command)
       "#{name}#{' ' * (@log_line_length - name.length - command.length)}#{command}"
     end
 
     def on_connect(msg)
-      if @use_savestates
-        @savestate_thread = Thread.new do
-          loop do
-            sleep @savestate_interval
-            press(@keys[:save_state])
-          end
+      return unless @use_savestates
+      @savestate_thread = Thread.new do
+        key = @keys[:save_state]
+        loop do
+          sleep @savestate_interval
+          Output.press(key)
         end
       end
     end
@@ -181,26 +105,69 @@ module TwitchPlays
       message = msg.message
       case message
       when /^anarchy$/i
+        return unless @use_democracy
         puts format_log_line(msg.user.nick, message.downcase)
-        @anarchy_votes += 1
-        if @democracy_mode && calculate_ratio <= @anarchy_ratio_needed
-          start_anarchy
+        synchronize(:votes_mutex) do
+          @anarchy_votes += 1
+          if @democracy_mode && calculate_ratio <= @anarchy_ratio_needed
+            start_anarchy
+          end
         end
       when /^democracy$/i
+        return unless @use_democracy
         puts format_log_line(msg.user.nick, message.downcase)
-        @democracy_votes += 1
-        if !@democracy_mode && calculate_ratio >= @democracy_ratio_needed
-          start_democracy
+        synchronize(:votes_mutex) do
+          @democracy_votes += 1
+          if !@democracy_mode && calculate_ratio >= @democracy_ratio_needed
+            start_democracy
+          end
         end
-      when /^up|down|left|right|a|b|x|y|l|r|start|select$/i
+      when /^(?:up|down|left|right|a|b|x|y|l|r|start|select)$/i
         btn = $&.to_sym
+        return unless @keys.has_key?(btn)
+        if @democracy_mode
+          synchronize(:votes_mutex) do
+            @total_votes += 1
+            @button_votes[btn] += 1
+          end
+          return
+        end
+        puts format_log_line(msg.user.nick, message.downcase)
+        Output.press(@keys[btn])
+      when /^(?:touch_up|touch_down|touch_left|touch_right)$/i
+        return unless @use_touch
+        btn = $&.to_sym
+        if @democracy_mode
+          synchronize(:votes_mutex) do
+            @total_votes += 1
+            @button_votes[btn] += 1
+          end
+          return
+        end
+        puts format_log_line(msg.user.nick, message.downcase)
+        Output.touch_move(*@touch_directions[btn])
+      when /^touch_press$/i
+        return unless @use_touch
         if @democracy_mode
-          @total_votes += 1
-          @button_votes[btn] += 1
+          synchronize(:votes_mutex) do
+            @total_votes += 1
+            @button_votes[$&.to_sym] += 1
+          end
           return
         end
-        puts format_log_line(msg.user.nick, $&.downcase)
-        press(@keys[btn])
+        puts format_log_line(msg.user.nick, message.downcase)
+        Output.touch_press
+      when /^touch_release$/i
+        return unless @use_touch
+        if @democracy_mode
+          synchronize(:votes_mutex) do
+            @total_votes += 1
+            @button_votes[$&.to_sym] += 1
+          end
+          return
+        end
+        puts format_log_line(msg.user.nick, message.downcase)
+        Output.touch_release
       end
     end
   end
@@ -218,6 +185,9 @@ module TwitchPlays
         c.plugins.options[Plugin] = config
       end
     end
+    trap('INT') do
+      bot.quit
+    end
     bot.start
   end
 end

data/lib/twitch_plays/version.rb

@@ -1,3 +1,3 @@
 module TwitchPlays
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitch_plays
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rob Steward
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cinch
@@ -51,6 +51,9 @@ files:
 - bin/twitch_plays~
 - config.yml
 - lib/twitch_plays.rb
+- lib/twitch_plays/os.rb
+- lib/twitch_plays/os/win.rb
+- lib/twitch_plays/os/x11.rb
 - lib/twitch_plays/twitch_plays.rb
 - lib/twitch_plays/version.rb
 homepage: https://github.com/filialpails/twitch_plays
@@ -73,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Yet another Twitch Plays Pokemon clone.