-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
hide: | ||
- navigation | ||
--- | ||
|
||
# Frequently Asked Questions | ||
|
||
!!! bug "Work In Progress" | ||
|
||
This page is still being worked on, if you have any suggestions for a question, feel free to create an issue on | ||
GitHub, or let us know on the development discord server. | ||
|
||
## Missing synchronous alternatives for some functions | ||
|
||
While mcproto does provide synchronous functionalities for the general protocol interactions (reading/writing packets | ||
and lower level structures), any unrelated functionalities (such as HTTP interactions with the Minecraft API) will only | ||
provide asynchronous versions. | ||
|
||
This was done to reduce the burden of maintaining 2 versions of the same code. The only reason protocol interaction | ||
even have synchronous support is because it's needed for the [`Buffer`][mcproto.buffer.Buffer] | ||
class. (See [Issue \#128](https://github.com/py-mine/mcproto/issues/128) for more details on this decision.) | ||
|
||
Generally, we recommend that you just stick to using the asynchronous alternatives though, both since some functions | ||
only support async, and because async will generally provide you with a more scalable codebase, making it much easier | ||
to handle multiple things concurrently. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters