protoss

README

Gophercraft/protoss

Protoss is a tool used to decompile Protobuf message and BGS service descriptors from an executable file.

Protoss is specifically created for the purpose of decompiling BGS service definitions for use in Gophercraft, and might not be useful for other applications.

Workflow

Protoss uses its own output to assist in subsequent decompilation.

BGS services have additional metadata tucked away in their service descriptors, which need to be extracted.

1. Extract definitions

protoss game.exe -o proto

2. Compile extensions

./script/compile_extensions

3. Rebuild Protoss

go install -v github.com/Gophercraft/protoss/cmd/protoss

4. Re-extract definitions now with proper extensions available

protoss game.exe -o proto

Thanks

• https://github.com/marin-m/pbtk
• https://github.com/Shauren/protobuf-decompiler/

Documentation

Index

• func DumpBinary(binary_path string, options *DumpOptions) (err error)
• type DumpOptions
• type Reader
  • func OpenBinary(path string) (reader *Reader, err error)
  • func (reader *Reader) Close() (err error)
  • func (reader *Reader) ReadDescriptor() (file_descriptor *descriptorpb.FileDescriptorProto, err error)
  • func (reader *Reader) ReadDescriptorBytes() ([]byte, error)

Functions

func DumpBinary

func DumpBinary(binary_path string, options *DumpOptions) (err error)

Types

type DumpOptions

type DumpOptions struct {
	// The directory to output decompiled definitions to
	Output string
	// The Go package path to prepend to Protocol Buffers packages
	// when generating "go_package" attribute
	GoPrefix string
	// If true, output additional .json files to assist in ensuring accurate .proto decompilation
	JSON bool
	// If true, don't output descriptors that are in the google/ path
	IgnoreGoogle bool
}

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

Read

func OpenBinary

func OpenBinary(path string) (reader *Reader, err error)

func (*Reader) Close

func (reader *Reader) Close() (err error)

func (*Reader) ReadDescriptor

func (reader *Reader) ReadDescriptor() (file_descriptor *descriptorpb.FileDescriptorProto, err error)

func (*Reader) ReadDescriptorBytes

func (reader *Reader) ReadDescriptorBytes() ([]byte, error)