https://github.com/webdev03/meowclient
Library to connect to the Scratch API
https://github.com/webdev03/meowclient
hacktoberfest hacktoberfest-2023 library nodejs npm-package scratch-api typescript-definitions
Last synced: 6 months ago
JSON representation
Library to connect to the Scratch API
- Host: GitHub
- URL: https://github.com/webdev03/meowclient
- Owner: webdev03
- License: mit
- Created: 2022-01-23T08:54:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-18T17:16:11.000Z (about 1 year ago)
- Last Synced: 2024-11-03T06:33:00.631Z (11 months ago)
- Topics: hacktoberfest, hacktoberfest-2023, library, nodejs, npm-package, scratch-api, typescript-definitions
- Language: TypeScript
- Homepage: https://webdev03.github.io/meowclient/
- Size: 5.78 MB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Meowclient
A library to connect to [Scratch](https://scratch.mit.edu/).
## Installation
Run this command in a terminal.
```bash
npm install meowclient
```
## Example
```javascript
import { ScratchSession, Profile } from "meowclient";
const session = new ScratchSession();
await session.init("user", "pass");
const me = new Profile(session, session.username);
console.log("My status is " + (await me.getStatus()));
await session.logout();
```
This uses exclusively ESM (ECMAScript Modules) instead of CJS due to some dependencies meowclient uses.
## Getting Help
You can get help using Meowclient from the [official Meowclient forum topic](https://scratch.mit.edu/discuss/topic/574321/)
## Thanks
Thanks to all of the people who use my library!
Thanks to [Scratchclient](https://github.com/CubeyTheCube/scratchclient) and Raihan142857 ([CubeyTheCube](https://github.com/CubeyTheCube)) for a lot of the login stuff!