Skip to content

scratchcpp/scratchcpp-player

Repository files navigation

Contributors Forks Stargazers Issues MIT License


ScratchCPP Player

ScratchCPP is an application which runs Scratch projects, written in C++ and QML. It uses the scratchcpp-render library for rendering, which uses libscratchcpp to parse and run Scratch projects.

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License

About The Project

ScratchCPP screenshot

ScratchCPP is an ongoing project to build a fast and lightweight Scratch project player. It might not be as fast as TurboWarp (yet), but the main goal is to develop a project player that is lightweight.

Scratch requires a web browser to run and web browsers typically require a lot of resources (memory). The ScratchCPP project player doesn't depend on a web browser and uses less memory.

NOTE

This application is still in development and it doesn't run most Scratch projects correctly.

(back to top)

Getting Started

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

(back to top)

Usage

The UI is very simple to use. Paste the project URL in the text box and press the Load button. When the project loads, click on the green flag button to run it.

(back to top)

Roadmap

  • Loading from URL
  • Loading from a local file
  • Green flag button
  • Stop button
  • Turbo mode
  • FPS options
  • Stage size options
  • HQ pen
  • Mute sounds
  • Theme options (light/dark mode, accent color, etc.)

See the open issues for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

Distributed under the GNU General Public License. See LICENSE for more information.

(back to top)