takumi-packet 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +15 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +68 -0
- data/Rakefile +2 -0
- data/lib/takumi/packet.rb +54 -0
- data/lib/takumi/packet/dsl.rb +28 -0
- data/lib/takumi/packet/string.rb +22 -0
- data/lib/takumi/packet/ushort.rb +19 -0
- data/lib/takumi/packet/varint.rb +37 -0
- data/lib/takumi/packet/version.rb +5 -0
- data/takumi-packet.gemspec +22 -0
- metadata +85 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 85dcdf1aec2d1bf95e55f5ad99962d28514ec357
|
4
|
+
data.tar.gz: 9d18168b3d5c24278c7a878313a373cd2a2eeb5f
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d1ed81b1195e676d04ee121168d998f042ba711a5f7751d063ce3cc891564d204dac5ebfa9cb7ad37d5e3aaacae6401d1af8187914513fdceb057d312c80d638
|
7
|
+
data.tar.gz: f6e6c25d25f20e4561fd7b40d980021b22ee2b8d246db1e7947b6973656ec9b4f4e663ff828d26c9bf5d8e2595081b65b0f1fdc21cf709582ed0719e589bbcac
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 block_given?
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
# Takumi::Packet
|
2
|
+
|
3
|
+
minecraft protocol packet encode/decode utility.
|
4
|
+
|
5
|
+
Details: [Protocol - MinecraftCoalition](http://wiki.vg/Protocol)
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'takumi-packet'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install takumi-packet
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
### Gems use takumi-packet
|
26
|
+
|
27
|
+
- [blockgiven/takumi-server_list_ping](https://github.com/blockgiven/takumi-server_list_ping)
|
28
|
+
|
29
|
+
### Define packet
|
30
|
+
|
31
|
+
require 'ostruct'
|
32
|
+
require 'takumi/packet'
|
33
|
+
|
34
|
+
class Handshake < OpenStruct
|
35
|
+
include ::Takumi::Packet::Dsl
|
36
|
+
|
37
|
+
field :packet_id, :varint
|
38
|
+
field :version, :varint
|
39
|
+
field :server_address, :string
|
40
|
+
field :port, :ushort
|
41
|
+
field :next_state, :varint
|
42
|
+
end
|
43
|
+
|
44
|
+
### Encode packet
|
45
|
+
p Handshake.new({
|
46
|
+
packet_id: 0,
|
47
|
+
version: 4,
|
48
|
+
server_address: 'localhost',
|
49
|
+
port: 25565,
|
50
|
+
next_state: 1
|
51
|
+
}).to_s
|
52
|
+
|
53
|
+
# => "\x0F\x00\x04\tlocalhostc\xDD\x01"
|
54
|
+
|
55
|
+
### Decode packet
|
56
|
+
|
57
|
+
packet = "\x0F\x00\x04\tlocalhostc\xDD\x01"
|
58
|
+
|
59
|
+
p Handshake.decode(packet)
|
60
|
+
# => #<Handshake packet_id=0, version=4, server_address="localhost", port=[25565], next_state=1>
|
61
|
+
|
62
|
+
## Contributing
|
63
|
+
|
64
|
+
1. Fork it ( https://github.com/blockgiven/takumi-packet/fork )
|
65
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
66
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
67
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
68
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,54 @@
|
|
1
|
+
module Takumi
|
2
|
+
module Packet
|
3
|
+
class UnknownField < StandardError; end
|
4
|
+
|
5
|
+
module_function
|
6
|
+
|
7
|
+
def decode(packet_type, packet)
|
8
|
+
packet_size, read = Packet::Varint.decode(packet)
|
9
|
+
packet = packet[read, packet_size]
|
10
|
+
|
11
|
+
fields = {}
|
12
|
+
packet_type.fields.each do |field|
|
13
|
+
case field[:type]
|
14
|
+
when :varint
|
15
|
+
data, read = ::Takumi::Packet::Varint.decode(packet)
|
16
|
+
when :string
|
17
|
+
data, read = ::Takumi::Packet::String.decode(packet)
|
18
|
+
when :ushort
|
19
|
+
data, read = ::Takumi::Packet::Ushort.decode(packet)
|
20
|
+
else
|
21
|
+
raise ::Takumi::Packet::UnknownField, field.inspect
|
22
|
+
end
|
23
|
+
fields[field[:name]] = data
|
24
|
+
packet = packet[read..-1]
|
25
|
+
end
|
26
|
+
fields
|
27
|
+
end
|
28
|
+
|
29
|
+
def encode(packet_type, object)
|
30
|
+
packet = "".encode(Encoding::BINARY)
|
31
|
+
packet_type.fields.each do |field|
|
32
|
+
val = object.send(field[:name])
|
33
|
+
|
34
|
+
case field[:type]
|
35
|
+
when :varint
|
36
|
+
packet << ::Takumi::Packet::Varint.new(val).to_s
|
37
|
+
when :string
|
38
|
+
packet << ::Takumi::Packet::String.new(val).to_s
|
39
|
+
when :ushort
|
40
|
+
packet << ::Takumi::Packet::Ushort.new(val).to_s
|
41
|
+
else
|
42
|
+
raise ::Takumi::Packet::UnknownField, field.inspect
|
43
|
+
end
|
44
|
+
end
|
45
|
+
size = ::Takumi::Packet::Varint.new(packet.size).to_s
|
46
|
+
size + packet
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
|
51
|
+
require "takumi/packet/dsl"
|
52
|
+
require "takumi/packet/varint"
|
53
|
+
require "takumi/packet/string"
|
54
|
+
require "takumi/packet/ushort"
|
@@ -0,0 +1,28 @@
|
|
1
|
+
module Takumi
|
2
|
+
module Packet
|
3
|
+
module Dsl
|
4
|
+
def self.included(base)
|
5
|
+
base.extend(ClassMethods)
|
6
|
+
end
|
7
|
+
|
8
|
+
module ClassMethods
|
9
|
+
def field(name, type)
|
10
|
+
fields << {name: name, type: type}
|
11
|
+
end
|
12
|
+
|
13
|
+
def fields
|
14
|
+
@fields ||= []
|
15
|
+
end
|
16
|
+
|
17
|
+
def decode(packet)
|
18
|
+
attrs = ::Takumi::Packet.decode(self, packet)
|
19
|
+
new(attrs)
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
def to_s
|
24
|
+
::Takumi::Packet.encode(self.class, self)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
module Takumi
|
2
|
+
module Packet
|
3
|
+
class String
|
4
|
+
class << self
|
5
|
+
def decode(source)
|
6
|
+
size, read = ::Takumi::Packet::Varint.decode(source)
|
7
|
+
return source[read, size], (size + read)
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
def initialize(str)
|
12
|
+
@str = str
|
13
|
+
end
|
14
|
+
|
15
|
+
def to_s
|
16
|
+
packet = "".encode(Encoding::BINARY)
|
17
|
+
packet << ::Takumi::Packet::Varint.new(@str.bytesize).to_s
|
18
|
+
packet << @str.dup.force_encoding(Encoding::BINARY)
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
module Takumi
|
2
|
+
module Packet
|
3
|
+
class Ushort
|
4
|
+
class << self
|
5
|
+
def decode(source)
|
6
|
+
return source[0..1].unpack("n"), 2
|
7
|
+
end
|
8
|
+
end
|
9
|
+
|
10
|
+
def initialize(ushort)
|
11
|
+
@ushort = ushort
|
12
|
+
end
|
13
|
+
|
14
|
+
def to_s
|
15
|
+
[@ushort].pack("n")
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
module Takumi
|
2
|
+
module Packet
|
3
|
+
class Varint
|
4
|
+
class << self
|
5
|
+
def decode(source)
|
6
|
+
int = 0
|
7
|
+
source.chars.each.with_index(1) do |char, index|
|
8
|
+
byte = char.ord
|
9
|
+
int += byte & 0b111_1111
|
10
|
+
|
11
|
+
return int, index if (byte & 0b1000_0000).zero?
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
def initialize(int)
|
17
|
+
@int = int
|
18
|
+
end
|
19
|
+
|
20
|
+
def to_s
|
21
|
+
packet = "".encode(Encoding::BINARY)
|
22
|
+
int = @int
|
23
|
+
loop do
|
24
|
+
bits = int & 0b111_1111
|
25
|
+
int = int >> 7
|
26
|
+
|
27
|
+
if int.zero?
|
28
|
+
packet << bits.chr and break
|
29
|
+
else
|
30
|
+
packet << (bits | 0b1000_0000).chr
|
31
|
+
end
|
32
|
+
end
|
33
|
+
packet
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'takumi/packet/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "takumi-packet"
|
8
|
+
spec.version = Takumi::Packet::VERSION
|
9
|
+
spec.authors = ["block_given?"]
|
10
|
+
spec.email = ["block_given@outlook.com"]
|
11
|
+
spec.summary = %q{minecraft protocol packet encode/decode utility.}
|
12
|
+
spec.homepage = "https://github.com/blockgiven/takumi-packet"
|
13
|
+
spec.license = "MIT"
|
14
|
+
|
15
|
+
spec.files = `git ls-files -z`.split("\x0")
|
16
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
21
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
22
|
+
end
|
metadata
ADDED
@@ -0,0 +1,85 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: takumi-packet
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- block_given?
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-10-26 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.7'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
description:
|
42
|
+
email:
|
43
|
+
- block_given@outlook.com
|
44
|
+
executables: []
|
45
|
+
extensions: []
|
46
|
+
extra_rdoc_files: []
|
47
|
+
files:
|
48
|
+
- ".gitignore"
|
49
|
+
- Gemfile
|
50
|
+
- LICENSE.txt
|
51
|
+
- README.md
|
52
|
+
- Rakefile
|
53
|
+
- lib/takumi/packet.rb
|
54
|
+
- lib/takumi/packet/dsl.rb
|
55
|
+
- lib/takumi/packet/string.rb
|
56
|
+
- lib/takumi/packet/ushort.rb
|
57
|
+
- lib/takumi/packet/varint.rb
|
58
|
+
- lib/takumi/packet/version.rb
|
59
|
+
- takumi-packet.gemspec
|
60
|
+
homepage: https://github.com/blockgiven/takumi-packet
|
61
|
+
licenses:
|
62
|
+
- MIT
|
63
|
+
metadata: {}
|
64
|
+
post_install_message:
|
65
|
+
rdoc_options: []
|
66
|
+
require_paths:
|
67
|
+
- lib
|
68
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
69
|
+
requirements:
|
70
|
+
- - ">="
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: '0'
|
73
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
74
|
+
requirements:
|
75
|
+
- - ">="
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '0'
|
78
|
+
requirements: []
|
79
|
+
rubyforge_project:
|
80
|
+
rubygems_version: 2.2.2
|
81
|
+
signing_key:
|
82
|
+
specification_version: 4
|
83
|
+
summary: minecraft protocol packet encode/decode utility.
|
84
|
+
test_files: []
|
85
|
+
has_rdoc:
|