Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is there api documentation? #554

Open
kagangtuya-star opened this issue Aug 17, 2024 · 1 comment
Open

Is there api documentation? #554

kagangtuya-star opened this issue Aug 17, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation P-medium

Comments

@kagangtuya-star
Copy link

I see the Boluo's description has "open source and API."
Is there any api documentation for this?
I'd like to try to implement an external plugin to access a dice framework like Dicepp or Sealdice, to provide more functionality to extend.
This should only use api's related to sending and receiving messages.

@uonr
Copy link
Collaborator

uonr commented Aug 17, 2024

Currently there are only Typescript type definitions, which can be found here

https://github.com/mythal/boluo/blob/master/packages/api/src/get.ts

https://github.com/mythal/boluo/blob/master/packages/api/src/post.ts

In order to receive messages, you need to establish a WebSockets connection:

https://github.com/mythal/boluo/blob/master/apps/spa/hooks/useConnectionEffect.tsx#L11

I can provide some standalone example programs using the basic APIs

@uonr uonr added documentation Improvements or additions to documentation P-medium labels Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation P-medium
Projects
None yet
Development

No branches or pull requests

2 participants