Skip to content

Commit

Permalink
Add FAQ page
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsDrike committed Jan 8, 2025
1 parent 3abed54 commit dfcb1ea
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/faq.md
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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ nav:
- First steps: usage/first-steps.md
- Packet Communication: usage/packet-communication.md
- Authentication: usage/authentication.md
- FAQ: faq.md
- Community:
- Code of Conduct: community/code-of-conduct.md
- Attributions: community/attribution.md
Expand Down

0 comments on commit dfcb1ea

Please sign in to comment.