Skip to content

Commit 9b43685

Browse files
authored
Update README.md
1 parent f96736b commit 9b43685

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.md

+19-15
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,27 @@ Python library for classic Battle.net client development.
44
For more information on available functions and classes, refer to [the wiki](https://github.com/Davnit/bncs.py/wiki).
55

66
## Packages
7-
* `bncs` - the main Battle.net Chat Service (BNCS)
8-
* `crev` - functions and classes for handling CheckRevision
9-
* `check_version(archive, formula, [files[]], [platform], [timestamp])` - performs CheckRevision() and returns results
10-
* `get_file_meta(file)` - returns version number and info string of a PE file
11-
* NOTE: Lockdown CheckRevision is not currently supported and will raise an exception if attempted.
12-
* `utils` - general utilities for the library and BNET ecosystem
13-
* `DataBuffer`, `DataReader` - binary packet buffer for writing and reading respectively
14-
* `hashing` - handles XSha1, NLS, and SigVerify (CD key and password hashing)
15-
* `KeyDecoder` - decodes CD keys and returns hashing values
16-
* `NLSClient`, `NLSServer` - client and server implementations of the 'new login system' (NLS)
17-
* `check_signature(sig, ip)` - server signature verification
18-
* `xsha()`, `hash_password`, `double_hash_password` - Broken SHA-1 (xsha) hashing
7+
* `bncs` - handles connecting to and interacting with the Battle.net Chat Service
8+
* `chat` - relating to the chat environment (users, channels, flags)
9+
* `crev` - functions and classes for handling the client version checking process - supports classic, lockdown, and simple/modern variants
10+
* `get_file_meta(file)` - returns the version number (DWORD) and filename, timestamp, and size of the given file, usually an EXE
11+
* `LocalHashingProvider(root)` - class which performs version checking operations from the local file system, partially interface compatible with `bnls.BnlsClient()`
12+
* `hashing` - handles CD key and password hashing
13+
* `KeyDecoder.get(key)` - decodes a given CD/product key and identifies it
14+
* `NLSClient(username, password)`, `NLSServer` - client and server implementations of the 'new login system' (NLS), an SRP-based system for verifying account logins
15+
* `check_signature(sig, ip)` - verifies that the signature presented by a server is valid for that server's IP address
16+
* `hash_password(password)`, `double_hash_password(password, c_token, s_token)`, `xsha1(data)` - hashes passwords and other data with Blizzard's custom SHA1 implementation
17+
* `lockdown_sha1(data)` - hashes data using another one of Blizzard's custom SHA1 implementations
18+
* `mcp` - handles the Diablo 2 realm service
19+
* `products` - contains packet ID constants and classes for reading and writing BNCS packets
20+
* `utils` - generic utilities (packet buffer, async TCP client)
21+
* `BnetClient()` - handles a complete connection to the chat service
22+
* `BnetProduct.get(pid)` - provides access to metadata on game clients that can connect to Battle.net
23+
* `BnetIconFile.load(file)` - extracts game icons from an icon file (.bni)
24+
* `CreditQueue()` - a system for delaying outbound chat messages to avoid rate limiting/flooding
1925
* `bnls` - the Battle.net Logon Service (3rd party)
20-
* `BnlsClient` - a client for interacting with a BNLS server
26+
* `BnlsClient()` - a client for interacting with a BNLS server
2127
* `bnftp` - the Battle.net FTP service
2228
* `BnftpClient` - downloads files available through the BNFTP protocol
2329
* `botnet` - the Valhalla Legends BotNet service (used for inter-bot communication)
2430
* `BotNetClient` - a client for interacting with a BotNet server
25-
26-
Packages also contain constants used with each system. (SID_AUTH_INFO, BNLS_AUTHORIZE, EID_SHOWUSER, etc).

0 commit comments

Comments
 (0)