libscratchcpp

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 43 Open GitHub ↗

C++ library for building Scratch project players

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<a name="readme-top"></a>

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

<div align="center">

<h3 align="center">libscratchcpp</h3>

A library for C++ based Scratch project players
 
 
 
 <a href="https://github.com/scratchcpp/libscratchcpp/issues">Report Bug</a>
 ·
 <a href="https://github.com/scratchcpp/libscratchcpp/issues">Request Feature</a>
 
</div>

<details>
 <summary>Table of Contents</summary>
 <ol>
 <li>
 <a href="#about-the-project">About The Project</a>
 </li>
 <li>
 <a href="#getting-started">Getting Started</a>
 </li>
 <li><a href="#usage">Usage</a></li>
 <li><a href="#roadmap">Roadmap</a></li>
 <li><a href="#contributing">Contributing</a></li>
 <li><a href="#license">License</a></li>
 </ol>
</details>

## About The Project

**libscratchcpp** is a library for building C++ based Scratch project players.

It provides an API for reading and running Scratch projects which makes it easy
to create a GUI application that runs Scratch projects.

The idea is to implement Scratch blocks in C++ to build a fast project player
that is faster than the original Scratch VM.

## NOTE
This library is still in development and it shouldn't be used
to build complete Scratch project players yet.

**There might be incompatible API changes anytime before version 1.0.0 releases!**

(<a href="#readme-top">back to top</a>)

## Getting Started

We're working on the documentation, it'll be available soon.

(<a href="#readme-top">back to top</a>)

## Usage

A minimal CLI program for running Scratch projects:
```cpp
#include <scratchcpp/project.h>

int main(int argc, char **argv) {
  libscratchcpp::Project p("/path/to/project.sb3");
  bool ret = p.load();
  if (!ret)
    return 1;

p.run();
  return 0;
}
```

Loading projects from [scratch.mit.edu](https://scratch.mit.edu/) is supported too:
```cpp
libscratchcpp::Project p("https://scratch.mit.edu/projects/XXXXXX");
```

(<a href="#readme-top">back to top</a>)

## Roadmap

- [x] Motion blocks
- [x] Looks blocks
- [x] Sound blocks
- [x] Event blocks
- [x] Control blocks
- [ ] Sensing blocks
- [x] Operator blocks
- [x] Custom blocks
- [x] Top level reporter blocks
- [x] Broadcasts
- [x] Variables
- [x] Lists
- [x] Clones
- [x] Timer
- [x] API for monitors
- [x] Project metadata
- [x] Turbo mode
- [x] Custom FPS in the default event loop (`libscratchcpp::Engine::run()`)
- [ ] Scratch 2.0 project loader (help needed)
- [ ] Scratch 1.4 and below project loader (help needed)
- [x] API for comments
- [x] API for loading projects from URL

See the [open issues](https://github.com/scratchcpp/libscratchcpp/issues) for a full list of proposed features (and known issues).

(<a href="#readme-top">back to top</a>)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Format changed source files (`clang-format src/some_file.cpp`)
4. Commit your Changes (`git add -A && git commit -m 'Add some AmazingFeature'`)
5. Push to the Branch (`git push origin feature/AmazingFeature`)
6. Open a Pull Request

(<a href="#readme-top">back to top</a>)

## License

Distributed under the Apache-2.0 License. See [LICENSE](LICENSE) for more information.

(<a href="#readme-top">back to top</a>)

[contributors-shield]: https://img.shields.io/github/contributors/scratchcpp/libscratchcpp.svg?style=for-the-badge
[contributors-url]: https://github.com/scratchcpp/libscratchcpp/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/scratchcpp/libscratchcpp.svg?style=for-the-badge
[forks-url]: https://github.com/scratchcpp/libscratchcpp/network/members
[stars-shield]: https://img.shields.io/github/stars/scratchcpp/libscratchcpp.svg?style=for-the-badge
[stars-url]: https://github.com/scratchcpp/libscratchcpp/stargazers
[issues-shield]: https://img.shields.io/github/issues/scratchcpp/libscratchcpp.svg?style=for-the-badge
[issues-url]: https://github.com/scratchcpp/libscratchcpp/issues
[license-shield]: https://img.shields.io/github/license/scratchcpp/libscratchcpp.svg?style=for-the-badge
[license-url]: https://github.com/scratchcpp/libscratchcpp/blob/master/LICENSE

libscratchcpp

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README