ssc.nob 0.1.0-java

data/README.md

@@ -0,0 +1,68 @@
+# SSC.Nob
+
+*SSC.Nob* is a simple bot I wrote for the game [Subspace Continuum](https://store.steampowered.com/app/352700/Subspace_Continuum/), just for fun!
+
+*SSC* stands for Subspace Continuum. *Nob* stands for Noble One Bot. Noble One (or Nob) is meant to be a gender-neutral version of King of the Hill.
+
+Subspace Continuum links:
+- [Windows / Linux (with wine)](http://subspace-continuum.com/trackdownload.php?type=win)
+- [macOS](http://subspace-continuum.com/trackdownload.php?type=mac)
+- [UDP Game Protocol [wiki]](http://wiki.minegoboom.com/index.php/UDP_Game_Protocol)
+
+It's **not** a server bot and can be run & used by any user in any zone & arena.
+
+It's currently **not** a [UDP packet](https://www.twcore.org/SubspaceProtocol/) bot. It simply reads a log file for input and uses Java's Robot class for output. For SSC.Nob2 or something, I'd like to read/write packets, but will probably never make it.
+
+## Running
+
+JRuby is required. [ruby-install](https://github.com/postmodern/ruby-install) & [chruby](https://github.com/postmodern/chruby) make this easy:
+
+```
+$ ruby-install jruby
+$ chruby jruby
+$ gem install bundler
+```
+
+It's pretty janky at the moment, but works.
+
+Run the app with JRuby:
+
+```
+$ bundler install
+$ ruby ./lib/ssc.nob.rb
+```
+
+**Note:** that's *bundler* with an *r*, not *bundle* (which doesn't work with JRuby).
+
+You'll be asked a couple of questions. Then input the `run` command.
+
+Current Subspace configuration:
+- In *Key Defs*, set the *Msg* key to *TAB*.
+- Once logged in...
+    - do `?log nob.log`
+    - do `?kill` until kill messages are set to display in the chat
+    - do `?namelen=24`
+
+Now to run *Nob*, private message yourself `!nob.start`. Private message yourself `!nob.stop` to stop it.
+
+[![asciinema demo](https://asciinema.org/a/325424.png)](https://asciinema.org/a/325424)
+
+## License
+
+[GNU GPL v3+](LICENSE.txt)
+
+> SSC.Nob (<https://github.com/esotericpig/ssc.nob>)  
+> Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)  
+> 
+> SSC.Nob is free software: you can redistribute it and/or modify  
+> it under the terms of the GNU General Public License as published by  
+> the Free Software Foundation, either version 3 of the License, or  
+> (at your option) any later version.  
+> 
+> SSC.Nob is distributed in the hope that it will be useful,  
+> but WITHOUT ANY WARRANTY; without even the implied warranty of  
+> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the  
+> GNU General Public License for more details.  
+> 
+> You should have received a copy of the GNU General Public License  
+> along with SSC.Nob.  If not, see <https://www.gnu.org/licenses/>. 

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Nob.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Nob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Nob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with SSC.Nob.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/clean'
+require 'rake/testtask'
+
+require 'ssc.nob/version'
+
+
+CLEAN.exclude('.git/','stock/')
+CLOBBER.include('doc/')
+
+task default: [:test]
+
+Rake::TestTask.new() do |task|
+  task.libs = ['lib','test']
+  task.pattern = File.join('test','**','*_test.rb')
+  task.description += ": '#{task.pattern}'"
+  task.verbose = false
+  task.warning = true
+end

data/bin/ssc.nob

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Nob.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Nob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Nob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with SSC.Nob.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'ssc.nob'
+
+SSCNob.run()

data/lib/ssc.nob.rb

@@ -0,0 +1,266 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Nob.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Nob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Nob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with SSC.Nob.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+TESTING = ($0 == __FILE__)
+
+if TESTING
+  require 'rubygems'
+  require 'bundler/setup'
+end
+
+require 'attr_bool'
+require 'time'
+
+require 'ssc.nob/config'
+require 'ssc.nob/error'
+require 'ssc.nob/ssc_bot'
+require 'ssc.nob/ssc_chat_log'
+require 'ssc.nob/userface'
+require 'ssc.nob/util'
+require 'ssc.nob/version'
+
+require 'ssc.nob/ssc_chat_log/message'
+require 'ssc.nob/ssc_chat_log/message_parser'
+
+
+# TODO: run options
+# run:
+# - Specify time limit (in seconds?).
+# - Specify money donation for winner.
+# - Specify who starts as Nob.
+# - Specify if testing, so do chat channel messages instead of pub.
+
+###
+# @author Jonathan Bradley Whited (@esotericpig)
+# @since  0.1.0
+###
+module SSCNob
+  def self.run()
+    nober = SSCNober.new()
+    
+    nober.run()
+  end
+  
+  def self.uface()
+    return Userface.instance
+  end
+  
+  class SSCNober
+    include Uface
+    
+    attr_reader :bot
+    attr_reader :chat_log
+    attr_reader :config
+    attr_reader :nob
+    attr_reader :nob_time
+    attr_reader :nobing
+    attr_reader :players
+    attr_accessor? :testing
+    attr_reader :thread
+    
+    def initialize(testing: false)
+      super()
+      
+      @bot = SSCBot.new()
+      @chat_log = nil
+      @config = Config.new()
+      @nob = nil
+      @nob_time = Time.now()
+      @nobing = false
+      @players = {}
+      @testing = testing
+      @thread = nil
+    end
+    
+    def run()
+      begin
+        puts
+        @config.user_init!()
+        puts
+      rescue UserError => e
+        puts
+        puts uface.error(e)
+        
+        return
+      end
+      
+      @chat_log = SSCChatLog.new(@config)
+      
+      @chat_log.add_listener(&method(:kill_message))
+      @chat_log.add_listener(&method(:private_message))
+      @chat_log.add_listener(&method(:pub_message))
+      @chat_log.add_listener(&method(:q_namelen_message))
+      
+      puts <<~EOH
+        #{uface.title('COMMANDS')}
+        #{uface.cmd('run')}           runs Nob
+        #{uface.cmd('stop')}          stops Nob
+        #{uface.cmd('exit, quit')}    goodbye, user
+      EOH
+      puts
+      
+      while true
+        cmd = uface.ask(uface.gt())
+        cmd = Util.strip(cmd.to_s()).downcase()
+        
+        case cmd
+        when 'exit','quit'
+          @chat_log.stop()
+          
+          puts
+          uface.types("You don't #{uface.love('love')} me? #{uface.love('<3')}")
+          puts
+          
+          return
+        when 'run'
+          if @chat_log.running?()
+            puts
+            puts uface.error('stop the current Nob first, user.')
+            puts
+          else
+            @chat_log.run()
+          end
+        when 'stop'
+          @chat_log.stop()
+        else
+          puts
+          puts uface.error("that's an invalid command, user.")
+          puts
+        end
+      end
+    end
+    
+    def kill_message(chat_log,msg)
+      return unless @nobing
+      return unless msg.kill?()
+      
+      if msg[:killed] == @nob
+        old_nob = @players[@nob]
+        old_nob[:time] += (Time.now() - @nob_time)
+        
+        killer = msg[:killer]
+        new_nob = @players[killer]
+        
+        if new_nob.nil?()
+          new_nob = {nobs: 0,time: 0,username: killer}
+          @players[killer] = new_nob
+        end
+        
+        new_nob[:nobs] += 1
+        
+        @nob = killer
+        @nob_time = Time.now()
+        
+        @bot.pub_message("Nob} {#{killer}} is now the Nob!")
+      end
+    end
+    
+    def private_message(chat_log,msg)
+      return unless msg.private?()
+      
+      if msg[:username] == @config.username
+        case msg[:message]
+        when '!nob.start'
+          return if @nobing # Already nobing
+          
+          @nob = @config.username
+          
+          @players = {
+            @nob => {nobs: 1,time: 0,username: @nob}
+          }
+          
+          if !@thread.nil?()
+            @thread.kill() if @thread.alive?()
+            
+            @thread = nil
+          end
+          
+          @bot.pub_message('Nob} Nob bot loaded (Noble One) for 5 min!')
+          @bot.pub_message("Nob} Kill {#{@nob}} to become the Nob!")
+          
+          @nobing = true
+          @nob_time = Time.now()
+          
+          @thread = Thread.new() do
+            sleep(5 * 60)
+            
+            @nobing = false
+            
+            nobler = @players[@nob]
+            nobler[:time] += (Time.now() - @nob_time)
+            
+            tops = @players.values.sort() do |p1,p2|
+              p2[:time] <=> p1[:time]
+            end
+            tops = tops[0..2]
+            
+            @bot.pub_message('Nob} Nob bot ended!')
+            @bot.pub_message(sprintf('Nob}    | %-24s | # of Nobs | Time','Nobler'))
+            @bot.pub_message("Nob}    | #{'-' * 24} | #{'-' * 9} | #{'-' * 8}")
+            
+            tops.each_with_index() do |top,i|
+              msg = sprintf("Nob} ##{i + 1} | %-24s | %-9s | %s secs",
+                top[:username],top[:nobs],top[:time].round(2))
+              
+              @bot.pub_message(msg)
+            end
+            
+            top = tops[0]
+            
+            @bot.pub_message("Nob} {#{top[:username]}} is the top Nob! Congrats!")
+          end
+        when '!nob.stop'
+          @nobing = false
+          @players = {}
+          
+          if !@thread.nil?()
+            @thread.kill() if @thread.alive?()
+            
+            @thread = nil
+          end
+        end
+      end
+    end
+    
+    def pub_message(chat_log,msg)
+      return unless @nobing
+      return unless msg.pub?()
+      
+      if msg[:username] == @config.username
+        @bot.prevent_flooding()
+      end
+    end
+    
+    def q_namelen_message(chat_log,msg)
+      return unless msg.q_namelen?()
+      
+      puts
+      puts "Using namelen{#{msg[:namelen]}}."
+      print uface.gt()
+    end
+  end
+end
+
+if TESTING
+  SSCNob.run()
+end

data/lib/ssc.nob/config.rb

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of SSC.Nob.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# SSC.Nob is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# SSC.Nob is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with SSC.Nob.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'psych'
+
+require 'ssc.nob/error'
+require 'ssc.nob/userface'
+require 'ssc.nob/util'
+
+
+module SSCNob
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  class Config
+    include Uface
+    
+    attr_reader :file
+    attr_accessor :ssc_dir
+    attr_accessor :username
+    
+    def initialize(file='ssc.nob.yml')
+      super()
+      
+      @file = File.expand_path(file)
+      @ssc_dir = nil
+      @username = nil
+    end
+    
+    def build_ssc_log_dir()
+      return File.join(@ssc_dir,'logs')
+    end
+    
+    def check_ssc_dir()
+      @ssc_dir = Util.strip(@ssc_dir)
+      
+      if @ssc_dir.nil?() || @ssc_dir.empty?()
+        raise UserError,"that's a blank folder name, user."
+      end
+      
+      @ssc_dir = File.expand_path(@ssc_dir)
+      
+      if !Dir.exist?(@ssc_dir)
+        raise UserError,"that folder{#{@ssc_dir}} doesn't exist, user."
+      end
+      if !File.directory?(@ssc_dir)
+        raise UserError,"that's a file{#{@ssc_dir}}, not a folder, user."
+      end
+      
+      ssc_log_dir = build_ssc_log_dir()
+      
+      if !Dir.exist?(ssc_log_dir) || !File.directory?(ssc_log_dir)
+        raise UserError,"why's there no 'logs' folder{#{ssc_log_dir}}, user?"
+      end
+    end
+    
+    def check_username()
+      raise UserError,"that's a blank username, user." if Util.blank?(@username)
+    end
+    
+    def load_file!(mode: 'rt:BOM|UTF-8',**kargs)
+      data = File.read(@file,mode: mode,**kargs)
+      
+      yaml = Psych.safe_load(data,
+        aliases: false,
+        filename: @file,
+        permitted_classes: [Symbol],
+        symbolize_names: true,
+        **kargs,
+      )
+      
+      @ssc_dir = Util.strip(yaml[:ssc_dir])
+      @ssc_dir = File.expand_path(@ssc_dir) if !@ssc_dir.nil?() && !@ssc_dir.empty?()
+      @username = yaml[:username]
+    end
+    
+    def save_file(mode: 'wt',**kargs)
+      File.open(@file,mode: mode,**kargs) do |fout|
+        fout.write(to_s())
+      end
+    end
+    
+    def user_init!()
+      if File.exist?(@file)
+        load_file!()
+      end
+      
+      if valid?()
+        uface.type("Welcome back, ")
+        puts "#{uface.user(@username)}."
+        uface.type("Here's a hot cup of coffee: ")
+        puts uface.coffee
+      else
+        uface.types('Welcome, new user.')
+        puts
+        
+        @username = uface.ask("What's your #{uface.user('username')}? ")
+        check_username()
+        
+        @ssc_dir = uface.ask("Where's your #{uface.ssc} folder? ")
+        check_ssc_dir()
+        
+        puts
+        puts uface.gt(@file)
+        if uface.agree('Save this configuration (y/n)? ')
+          save_file()
+        end
+      end
+    end
+    
+    def valid?()
+      begin
+        check_ssc_dir()
+        check_username()
+      rescue UserError
+        return false
+      end
+      
+      return true
+    end
+    
+    def to_s()
+      yaml = {
+        'username' => @username,
+        'ssc_dir' => @ssc_dir,
+      }
+      
+      return Psych.dump(yaml,header: true)
+    end
+  end
+end