search

the-marenga / sf-api

Manage Shakes & Fidget characters via simple commands. Handles encryption, response parsing and everything else for you
MIT License
17 stars 3 forks source link

Adding example of the api usage #14

Closed Sempoinus1 closed 9 months ago

the-marenga commented 9 months ago

Hey, thanks for the PR! I feel like there is a better place, than the example folder for this though. Examples should probably be more focused on showcasing interactions of commands & gamestate, i.e. 'How to start/wait for/end quests', 'How to navigate expeditions', or 'How to send regular update commands' and less on integration with other tools like a database.

If you create a new independent repo with your code, that other people can clone & run, I'd love to add a "Showcase" section to the readme, that links to yours and other projects, that use this API though. Something alone the lines of:

Description Link
A GUI tool to quickly fetch the scrapbook https://github.com/the-marenga/sf-scrapbook-helper
Send out discord notification about guild events via a DB https://github.com/Sempoinus1/sf-db-notify
Automatic scrapbook fighting with steam SSO support https://github.com/novosadkry/sfscraper-rs
Sempoinus1 commented 9 months ago

Alrighty! I'm on it then. I was wondering if it's even good idea to pull whole solution as example. I will rework that.

I will try to do some simplified examples too