silkroad-security v0.0.7

Silkroad Security JS

This project is a Drew's SilkroadSecurity API wrapper to be use in node.js.

Requirements

"node": ">=12.0.0"

Installation

This security system is crossplatform, you can use it on unix (linux, macos (darwin)) system and win32/win64.

npm install silkroad-security --ignore-scripts

You can also install without ignoring scripts (it'll compile library during the installation, then you'll need to do the requirements step for compiling).

Install without ignoring scripts:

npm install silkroad-security

Usage

const { SilkroadSecurityJS, stream } = require('silkroad-security-js')

//Security
let security = new SilkroadSecurityJS("SR_Client", 0)

security.GenerateHandshake(blowfish = true, security_bytes = true, handshake = true)
security.ChangeIdentity(identity_name = "SR_Client", identity_flag = 0)
security.Recv(data) //data can be instance of Array or Buffer
security.Send(opcode = 0x0000, data = [], encrypted = false, massive = false) //data can be instance of Array, Buffer or a stream
security.GetPacketToRecv() // return [{ opcode, data, encrypted, massive }]
security.GetPacketToSend() // return [{ opcode, data, encrypted, massive }]

//Stream
let reader = new stream.reader(data) //data is the stream to read should be an array of int
reader.uint8()
reader.uint16()
reader.uint32()
reader.uint64()
reader.string()
reader.float()
reader.bool()
reader.toData() // extract the current buffer to array of int

let writer = new stream.writer()
writer.uint8()
writer.uint16()
writer.uint32()
writer.uint64()
writer.string()
writer.float()
writer.bool()
writer.toData() // extract the current buffer to array of int

Examples

clientless.js in this project you can see how Silkroad Security JS is working, you've to change IP, Port, version and local to make it working. This project will show you Silkroad Server status and capacity, you can also change it for join the game world.

Compiling

Requirements

Boost :

• linux : apt-get install libboost-dev
• macos : brew install boost
• windows : Get boost for windows

Usage

npm install
node-gyp configure
node-gyp build

Then you'll find all .node file in build folder

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Credits

Drew (pushedx) Weeman

License

MIT