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

Add documentation on SplashKit API support in SplashKit Online #81

Merged
merged 4 commits into from
May 20, 2024

Conversation

WhyPenguins
Copy link
Contributor

Description

This PR adds documentation about how much of the SplashKit API is supported currently by SplashKit Online, across its two currently supported languages.

Type of change

  • Documentation (update or new)

How Has This Been Tested?

The documentation has been linted, and viewed on a local copy of the website. The tests themselves have been performed manually and results observed.

Testing Checklist

  • Tested in latest Chrome
  • Tested in latest Safari
  • Tested in latest Firefox

Checklist

  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

Copy link

netlify bot commented May 17, 2024

Deploy Preview for strong-fairy-c1bde1 ready!

Name Link
🔨 Latest commit 4ad8cfb
🔍 Latest deploy log https://app.netlify.com/sites/strong-fairy-c1bde1/deploys/664b4d6a488d8e0008fc7b54
😎 Deploy Preview https://deploy-preview-81--strong-fairy-c1bde1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@WhyPenguins
Copy link
Contributor Author

Copy link
Contributor

@Liquidscroll Liquidscroll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really good! Only one small change, you left the localhost link in.

| Sprites | Full Support | Full Support | |
| Terminal | Partial Support | Limited Support | **JavaScript**: it all _works_, but no terminal input bar. 'Input' _popup_ appears, that has confusing behaviour of only sending data once _cancelled_. This may be fixed very shortly however. <br/>**C++**: all the _read_ functions return immediately with no input. |
| Timers | Full Support | Full Support | |
| Utilities | Near Full Support | Near Full Support | [Display Dialog](http://localhost:4321/api/utilities/#display-dialog) does not work, as it enters a busy loop that freezes the page. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you want this link here and not localhost: https://splashkit.io/api/utilities/#display-dialog

Copy link
Collaborator

@omckeon omckeon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a fantastic document for future Splashkit Online work :)

@omckeon omckeon merged commit c42d5a1 into thoth-tech:main May 20, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants