teeworlds_network 0.0.2

data/lib/network.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+GAME_VERSION = '0.7.5'
+GAME_NETVERSION_HASH_FORCED = '802f1be60a05665f'
+GAME_NETVERSION = "0.7 #{GAME_NETVERSION_HASH_FORCED}".freeze
+CLIENT_VERSION = 0x0705
+
+NETMSG_NULL = 0
+NETMSG_INFO = 1
+NETMSG_MAP_CHANGE = 2 # sent when client should switch map
+NETMSG_MAP_DATA = 3   # map transfer, contains a chunk of the map file
+NETMSG_SERVERINFO = 4
+NETMSG_CON_READY = 5  # connection is ready, client should send start info
+NETMSG_SNAP = 6       # normal snapshot, multiple parts
+NETMSG_SNAPEMPTY = 7  # empty snapshot
+NETMSG_SNAPSINGLE = 8 # ?
+NETMSG_SNAPSMALL = 9
+NETMSG_INPUTTIMING = 10   # reports how off the input was
+NETMSG_RCON_AUTH_ON = 11  # rcon authentication enabled
+NETMSG_RCON_AUTH_OFF = 12 # rcon authentication disabled
+NETMSG_RCON_LINE = 13     # line that should be printed to the remote console
+NETMSG_RCON_CMD_ADD = 14
+NETMSG_RCON_CMD_REM = 15
+
+NETMSG_MAPLIST_ENTRY_ADD = 29 # TODO: 0.8: move up
+NETMSG_MAPLIST_ENTRY_REM = 30
+
+# sent by client
+NETMSG_READY = 18
+NETMSG_ENTERGAME = 19
+NETMSG_INPUT = 20 # contains the inputdata from the client
+NETMSG_RCON_CMD = 21
+NETMSG_RCON_AUTH = 22
+NETMSG_REQUEST_MAP_DATA = 23
+
+NETMSG_INVALID = 0
+NETMSGTYPE_SV_MOTD = 1
+NETMSGTYPE_SV_BROADCAST = 2
+NETMSGTYPE_SV_CHAT = 3
+NETMSGTYPE_SV_TEAM = 4
+NETMSGTYPE_SV_KILLMSG = 5
+NETMSGTYPE_SV_TUNEPARAMS = 6
+NETMSGTYPE_SV_EXTRAPROJECTILE = 7
+NETMSGTYPE_SV_READYTOENTER = 8
+NETMSGTYPE_SV_WEAPONPICKUP = 19
+NETMSGTYPE_SV_EMOTICON = 10
+NETMSGTYPE_SV_VOTECLEAROPTIONS = 11
+NETMSGTYPE_SV_VOTEOPTIONLISTADD = 12
+NETMSGTYPE_SV_VOTEOPTIONADD = 13
+NETMSGTYPE_SV_VOTEOPTIONREMOVE = 14
+NETMSGTYPE_SV_VOTESET = 15
+NETMSGTYPE_SV_VOTESTATUS = 16
+NETMSGTYPE_SV_SERVERSETTINGS = 17
+NETMSGTYPE_SV_CLIENTINFO = 18
+NETMSGTYPE_SV_GAMEINFO = 19
+NETMSGTYPE_SV_CLIENTDROP = 20
+NETMSGTYPE_SV_GAMEMSG = 21
+NETMSGTYPE_DE_CLIENTENTER = 22
+NETMSGTYPE_DE_CLIENTLEAVE = 23
+NETMSGTYPE_CL_SAY = 24
+NETMSGTYPE_CL_SETTEAM = 25
+NETMSGTYPE_CL_SETSPECTATORMODE = 26
+NETMSGTYPE_CL_STARTINFO = 27
+NETMSGTYPE_CL_KILL = 28
+NETMSGTYPE_CL_READYCHANGE = 29
+NETMSGTYPE_CL_EMOTICON = 30
+NETMSGTYPE_CL_VOTE = 31
+NETMSGTYPE_CL_CALLVOTE = 32
+NETMSGTYPE_SV_SKINCHANGE = 33
+NETMSGTYPE_CL_SKINCHANGE = 34
+NETMSGTYPE_SV_RACEFINISH = 35
+NETMSGTYPE_SV_CHECKPOINT = 36
+NETMSGTYPE_SV_COMMANDINFO = 37
+NETMSGTYPE_SV_COMMANDINFOREMOVE = 38
+NETMSGTYPE_CL_COMMAND = 39
+NUM_NETMSGTYPES = 40
+
+NET_CTRLMSG_KEEPALIVE = 0
+NET_CTRLMSG_CONNECT = 1
+NET_CTRLMSG_ACCEPT = 2
+NET_CTRLMSG_CLOSE = 4
+NET_CTRLMSG_TOKEN = 5
+
+NET_MAX_SEQUENCE = 1 << 10
+
+NET_CONNSTATE_OFFLINE = 0
+NET_CONNSTATE_TOKEN = 1
+NET_CONNSTATE_CONNECT = 2
+NET_CONNSTATE_PENDING = 3
+NET_CONNSTATE_ONLINE = 4
+NET_CONNSTATE_ERROR = 5
+
+NET_MAX_CHUNKHEADERSIZE = 3
+
+NET_PACKETHEADERSIZE = 7
+NET_PACKETHEADERSIZE_CONNLESS = NET_PACKETHEADERSIZE + 2
+NET_MAX_PACKETHEADERSIZE = NET_PACKETHEADERSIZE_CONNLESS
+
+NET_MAX_PACKETSIZE = 1400
+NET_MAX_PAYLOAD = NET_MAX_PACKETSIZE - NET_MAX_PACKETHEADERSIZE
+
+CHAT_NONE = 0
+CHAT_ALL = 1
+CHAT_TEAM = 2
+CHAT_WHISPER = 3
+NUM_CHATS = 4
+
+TARGET_SERVER = -1
+
+PACKET_HEADER_SIZE = 7
+VITAL_CHUNK_HEADER_SIZE = 3
+NON_VITAL_CHUNK_HEADER_SIZE = 2
+
+MAX_CLIENTS = 64
+MAX_PLAYERS = 16
+
+MAP_CHUNK_SIZE = NET_MAX_PAYLOAD - NET_MAX_CHUNKHEADERSIZE - 4 # msg type
+
+SERVER_TICK_SPEED = 50
+
+# should this be moved to some snap related file?
+
+NETOBJ_INVALID = 0
+NETOBJTYPE_PLAYERINPUT = 1
+NETOBJTYPE_PROJECTILE = 2
+NETOBJTYPE_LASER = 3
+NETOBJTYPE_PICKUP = 4
+NETOBJTYPE_FLAG = 5
+NETOBJTYPE_GAMEDATA = 6
+NETOBJTYPE_GAMEDATATEAM = 7
+NETOBJTYPE_GAMEDATAFLAG = 8
+NETOBJTYPE_CHARACTERCORE = 9
+NETOBJTYPE_CHARACTER = 10
+NETOBJTYPE_PLAYERINFO = 11
+NETOBJTYPE_SPECTATORINFO = 12
+NETOBJTYPE_DE_CLIENTINFO = 13
+NETOBJTYPE_DE_GAMEINFO = 14
+NETOBJTYPE_DE_TUNEPARAMS = 15
+NETEVENTTYPE_COMMON = 16
+NETEVENTTYPE_EXPLOSION = 17
+NETEVENTTYPE_SPAWN = 18
+NETEVENTTYPE_HAMMERHIT = 19
+NETEVENTTYPE_DEATH = 20
+NETEVENTTYPE_SOUNDWORLD = 21
+NETEVENTTYPE_DAMAGE = 22
+NETOBJTYPE_PLAYERINFORACE = 23
+NETOBJTYPE_GAMEDATARACE = 24
+NUM_NETOBJTYPE = 25

data/lib/packer.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require_relative 'array'
+
+SANITIZE = 1
+SANITIZE_CC = 2
+SKIP_START_WHITESPACES = 4
+
+class Packer
+  # Format: ESDDDDDD EDDDDDDD EDD... Extended, Data, Sign
+  def self.pack_int(num)
+    # the first byte can fit 6 bits
+    # because the first two bits are extended and sign
+    # so if you have a number bigger than 63
+    # it needs two bytes
+    # which are also least significant byte first etc
+    # so we do not support that YET
+    #
+    # the first too big number 64 is represented as those bits
+    # 10000000 00000001
+    # ^^^    ^ ^^    ^
+    # ||\   /  | \   /
+    # || \ / not  \ /
+    # ||  \ extended
+    # ||   \      /
+    # ||    \    /
+    # ||     \  /
+    # ||      \/
+    # ||      /\
+    # ||     /  \
+    # ||    /    \
+    # || 0000001 000000
+    # ||       |
+    # ||       v
+    # ||       64
+    # ||
+    # |positive
+    # extended
+    sign = '0'
+    if num.negative?
+      sign = '1'
+      num += 1
+    end
+    num = num.abs
+    return pack_big_int(sign, num) if num > 63 || num < -63
+
+    ext = '0'
+    bits = ext + sign + num.to_s(2).rjust(6, '0')
+    [bits.to_i(2)]
+  end
+
+  def self.pack_big_int(sign, num)
+    num_bits = num.to_s(2)
+    first = "1#{sign}#{num_bits[-6..]}"
+
+    num_bits = num_bits[0..-7]
+    bytes = []
+    num_bits.chars.groups_of(7).each do |seven_bits|
+      # mark all as extended
+      bytes << "1#{seven_bits.join.rjust(7, '0')}"
+    end
+    # least significant first
+    bytes = bytes.reverse
+    # mark last byte as unextended
+    bytes[-1][0] = '0'
+    ([first] + bytes).map { |b| b.to_i(2) }
+  end
+
+  def self.pack_str(str)
+    str.chars.map(&:ord) + [0x00]
+  end
+end
+
+class Unpacker
+  attr_reader :prev, :data, :parsed
+
+  def initialize(data)
+    @data = data
+    @prev = [] # all the data already unpacked
+    @parsed = []
+    # TODO: delete parsed or document it with examples
+    # @parsed.push({ type: 'string', value: str, raw:, len:, pos: })
+    @red_bytes = 0
+    # { type: 'int', value: 1, raw: "\x01", len: 1, pos: 0 }
+    if data.instance_of?(String)
+      @data = data.unpack('C*')
+    elsif data.instance_of?(Array)
+      @data = data
+    else
+      raise 'Error: Unpacker expects array of integers or byte string'
+    end
+  end
+
+  def str_sanitize(str)
+    letters = str.chars
+    letters.map! do |c|
+      c.ord < 32 && c != "\r" && c != "\n" && c != "\t" ? ' ' : c
+    end
+    letters.join
+  end
+
+  def str_sanitize_cc(str)
+    letters = str.chars
+    letters.map! do |c|
+      c.ord < 32 ? ' ' : c
+    end
+    letters.join
+  end
+
+  def get_string(sanitize = SANITIZE)
+    return nil if @data.nil?
+
+    str = ''
+    raw = []
+    len = 0
+    pos = @red_bytes
+    @data.each_with_index do |byte, index|
+      @prev.push(byte)
+      raw.push(raw)
+      @red_bytes += 1
+      len += 1
+      if byte.zero?
+        @data = index == @data.length - 1 ? nil : @data[(index + 1)..]
+        str = str_sanitize(str) unless (sanitize & SANITIZE).zero?
+        str = str_sanitize_cc(str) unless (sanitize & SANITIZE_CC).zero?
+        @parsed.push({ type: 'string', value: str, raw:, len:, pos: })
+        return str
+      end
+      str += byte.chr
+    end
+    # raise "get_string() failed to find null terminator"
+    # return empty string in case of error
+    ''
+  end
+
+  def get_int
+    return nil if @data.nil?
+    return nil if @data.empty?
+
+    # TODO: make this more performant
+    #       it should not read in ALL bytes
+    #       of the WHOLE packed data
+    #       it should be max 4 bytes
+    #       because bigger ints are not sent anyways
+    bytes = @data.map { |byte| byte.to_s(2).rjust(8, '0') }
+    first = bytes[0]
+
+    sign = first[1]
+    bits = []
+    parsed = { type: 'int' }
+
+    # extended
+    if first[0] == '1'
+      bits << first[2..]
+      bytes = bytes[1..]
+      consumed = 1
+      bytes.each do |eigth_bits|
+        bits << eigth_bits[1..]
+        consumed += 1
+
+        break if eigth_bits[0] == '0'
+      end
+      bits = bits.reverse
+      @prev += @data[0...consumed]
+      parsed[:raw] = @data[0...consumed]
+      parsed[:len] = consumed
+      parsed[:pos] = @red_bytes
+      @red_bytes += consumed
+      @data = @data[consumed..]
+    else # single byte
+      bits = [first[2..]]
+      @prev.push(@data[0])
+      parsed[:raw] = [@data[0]]
+      parsed[:len] = 1
+      parsed[:pos] = @red_bytes
+      @red_bytes += 1
+      @data = @data[1..]
+    end
+    num = bits.join.to_i(2)
+    parsed[:value] = sign == '1' ? -(num + 1) : num
+    @parsed.push(parsed)
+    parsed[:value]
+  end
+
+  def get_raw(size = -1)
+    len = size == -1 ? @data.size : size
+    @prev += @data[...len]
+    pos = @red_bytes
+    @red_bytes += len
+    @parsed.push({ type: 'raw', value: @data[...len], raw: @data[...len], len:, pos: })
+    # TODO: error if size exceeds @data.size
+    @data.shift(len)
+  end
+end

data/lib/packet.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative 'models/net_addr'
+require_relative 'models/packet_flags'
+
+require 'huffman_tw'
+
+# Class holding the parsed packet data
+class Packet
+  attr_reader :flags, :payload, :addr
+  attr_accessor :client_id, :client
+
+  def initialize(data, prefix = '')
+    # @data and @payload
+    # are strings representing the raw bytes
+    #
+    # @prefix is a String that will be displayed
+    #         when printing the packet
+    #         use '>' and '<' for example to indicate
+    #         network direction (client/server)
+    @prefix = prefix
+    @addr = NetAddr.new(nil, nil)
+    @huffman = Huffman.new
+    @client_id = nil
+    @client = nil
+    @data = data
+    flags_byte = @data[0].unpack('B*')
+    @flags = PacketFlags.new(flags_byte.first[2..5]).hash
+    @payload = @data[PACKET_HEADER_SIZE..]
+    return unless  flags_compressed
+
+    @payload = @huffman.decompress(@payload.unpack('C*'))
+    @payload = @payload.pack('C*')
+  end
+
+  def annotate_first_row(bytes)
+    header = bytes[0..2].join(' ').yellow
+    token = bytes[3..6].join(' ').green
+    payload = bytes[7..].join(' ')
+    puts @prefix + "  data: #{[header, token, payload].join(' ')}"
+    print "#{@prefix}        "
+    print 'header'.ljust(3 * 3, ' ').yellow
+    print 'token'.ljust(4 * 3, ' ').green
+    puts 'data'
+  end
+
+  def to_s
+    puts "#{@prefix}Packet"
+    puts @prefix + "  flags: #{@flags}"
+    bytes = str_hex(@data).split
+    # TODO: check terminal size?
+    max_width = 14
+    rows = bytes.groups_of(max_width)
+    annotate_first_row(rows.first)
+    rows[1..].each do |row|
+      print "#{@prefix}        "
+      puts row.join(' ')
+    end
+    puts ''
+  end
+
+  def flags_compressed
+    @flags[:compressed]
+  end
+
+  def flags_connless
+    @flags[:connection] == false
+  end
+
+  def flags_control
+    @flags[:control]
+  end
+end

data/lib/snapshot/events/damage.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../snap_event_base'
+
+class NetEvent
+  class Damage < SnapEventBase
+    attr_accessor :client_id, :angle, :health_ammount, :armor_amount, :self
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        client_id
+        angle
+        health_ammount
+        armor_amount
+        self
+      ]
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETEVENTTYPE_DAMAGE
+    end
+  end
+end

data/lib/snapshot/events/death.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../snap_event_base'
+
+class NetEvent
+  class Death < SnapEventBase
+    attr_accessor :client_id
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        client_id
+      ]
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETEVENTTYPE_DEATH
+    end
+  end
+end

data/lib/snapshot/events/explosion.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetEvent
+  class Explosion < SnapEventBase
+    def initialize(hash_or_raw)
+      @field_names = []
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETEVENTTYPE_EXPLOSION
+    end
+  end
+end

data/lib/snapshot/events/hammer_hit.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetEvent
+  class HammerHit < SnapEventBase
+    def initialize(hash_or_raw)
+      @field_names = []
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETEVENTTYPE_HAMMERHIT
+    end
+  end
+end

data/lib/snapshot/events/sound_world.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative '../snap_event_base'
+
+class NetEvent
+  class SoundWorld < SnapEventBase
+    attr_accessor :sound_id
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        sound_id
+      ]
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETEVENTTYPE_SOUNDWORLD
+    end
+  end
+end

data/lib/snapshot/events/spawn.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetEvent
+  class Spawn < SnapEventBase
+    def initialize(hash_or_raw)
+      @field_names = []
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETEVENTTYPE_SPAWN
+    end
+  end
+end

data/lib/snapshot/items/character.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetObj
+  class Character < SnapItemBase
+    attr_accessor :tick, :x, :y, :vel_x, :vel_y, :angle, :direction, :jumped, :hooked_player, :hook_state, :hook_tick,
+                  :hook_x, :hook_y, :hook_dx, :hook_dy,
+                  :health, :armor, :ammo_count, :weapon, :emote, :attack_tick, :triggered_events
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        tick
+        x
+        y
+        vel_x
+        vel_y
+        angle
+        direction
+        jumped
+        hooked_player
+        hook_state
+        hook_tick
+        hook_x
+        hook_y
+        hook_dx
+        hook_dy
+        health
+        armor
+        ammo_count
+        weapon
+        emote
+        attack_tick
+        triggered_events
+      ]
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETOBJTYPE_CHARACTER
+    end
+  end
+end

data/lib/snapshot/items/client_info.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetObj
+  class ClientInfo < SnapItemBase
+    attr_accessor :local, :team
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        local
+        team
+      ]
+      super
+      raise 'ClientInfo includes strings that is not supported yet'
+    end
+
+    def self.match_type?(type)
+      type == NETOBJTYPE_DE_CLIENTINFO
+    end
+  end
+end

data/lib/snapshot/items/flag.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetObj
+  class Flag < SnapItemBase
+    attr_accessor :x, :y, :team
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        x
+        y
+        team
+      ]
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETOBJTYPE_FLAG
+    end
+  end
+end

data/lib/snapshot/items/game_data.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetObj
+  class GameData < SnapItemBase
+    attr_accessor :game_start_tick, :game_state_flags, :game_state_end_tick
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        game_start_tick
+        game_state_flags
+        game_state_end_tick
+      ]
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETOBJTYPE_GAMEDATA
+    end
+  end
+end

data/lib/snapshot/items/game_data_flag.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetObj
+  class GameDataFlag < SnapItemBase
+    attr_accessor :flag_carrier_red, :flag_carrier_blue,
+                  :flag_drop_tick_red, :flag_drop_tick_blue
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        flag_carrier_red
+        flag_carrier_blue
+        flag_drop_tick_red
+        flag_drop_tick_blue
+      ]
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETOBJTYPE_GAMEDATAFLAG
+    end
+  end
+end

data/lib/snapshot/items/game_data_team.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../snap_item_base'
+
+class NetObj
+  class GameDataTeam < SnapItemBase
+    attr_accessor :teamscore_red, :teamscore_blue
+
+    def initialize(hash_or_raw)
+      @field_names = %i[
+        teamscore_red
+        teamscore_blue
+      ]
+      super
+    end
+
+    def self.match_type?(type)
+      type == NETOBJTYPE_GAMEDATATEAM
+    end
+  end
+end