codePugHacKEr/bedrock-protocol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update doc (#288)

Browse source 
* Update API.md

* Update README.md

* Update API.md
This commit is contained in:
extremeheat 2022-09-24 16:55:12 -04:00 • committed by GitHub
commit 3295c0ddd9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -7,7 +7,7 @@
Minecraft Bedrock Edition (aka MCPE) protocol library, supporting authentication and encryption. Help [contribute](CONTRIBUTING.md).
[Protocol doc](https://minecraft-data.prismarine.js.org/?v=bedrock_1.17.10&d=protocol)
[Protocol doc](https://minecraft-data.prismarine.js.org/?v=bedrock_1.19.10&d=protocol)
## Features
@ -102,11 +102,11 @@ ping({ host: 'play.cubecraft.net', port: 19132 }).then(res => {
## Documentation
For documentation on the protocol, and packets/fields see the [proto.yml](data/latest/proto.yml) and [types.yml](data/latest/proto.yml) files.
For documentation on the protocol, and packets/fields see the [protocol documentation](https://minecraft-data.prismarine.js.org/protocol/).
See [API documentation](docs/API.md)
* See [API documentation](docs/API.md)
See [faq](docs/FAQ.md)
* See [frequently asked questions and answers](docs/FAQ.md)
<!-- ## Projects Using bedrock-protocol

4
docs/API.md
View file

@ -12,7 +12,7 @@ Returns a `Client` instance and connects to the server.
| port | *optional* | port to connect to, default to **19132** |
| version | *optional* | Version to connect as. If not specified, automatically match server version. |
| offline | *optional* | default to **false**. Set this to true to disable Microsoft/Xbox auth. |
| username | Conditional | Required if `offline` set to true : Username to connect to server as. |
| username | Required | The profile name to connect to the server as. If `offline` set to true, the username that will appear on join, that would normally be the Xbox Gamer Tag. |
| connectTimeout | *optional* | default to **9000ms**. How long to wait in milliseconds while trying to connect to server. |
| onMsaCode | *optional* | Callback called when signing in with a microsoft account with device code auth, `data` is an object documented [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-device-code#device-authorization-response) |
| profilesFolder | *optional* | Where to store cached authentication tokens. Defaults to .minecraft, or the node_modules folder if not found. |
@ -118,7 +118,7 @@ A ServerPlayer instance also emits the following special events:
## Client docs
You can create a server as such:
You can create a client like below:
```js
const bedrock = require('bedrock-protocol')
const client = bedrock.createClient({