Rename the project to ScratchCPP Render

Author: adazem009

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.14)
 
-project(scratchcpp-gui VERSION 1.0.0 LANGUAGES CXX)
+project(scratchcpp-render VERSION 1.0.0 LANGUAGES CXX)
 
 set(CMAKE_INCLUDE_CURRENT_DIR ON)
 set(CMAKE_AUTOUIC ON)
@@ -9,27 +9,25 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-option(SCRATCHCPPGUI_BUILD_UNIT_TESTS "Build unit tests" ON)
+option(SCRATCHCPPRENDER_BUILD_UNIT_TESTS "Build unit tests" ON)
 
 include(build/FindQt.cmake)
 
 qt_standard_project_setup(REQUIRES 6.6)
-add_subdirectory(ScratchCPPGui)
+add_subdirectory(src)
 
-set(QML_IMPORT_PATH "${QML_IMPORT_PATH};${PROJECT_SOURCE_DIR}/src/qml" PARENT_SCOPE)
+target_compile_definitions(scratchcpp-render PRIVATE SCRATCHCPPRENDER_LIBRARY)
 
-target_compile_definitions(libscratchcpp-gui PRIVATE SCRATCHCPPGUI_LIBRARY)
-
-linkQt(libscratchcpp-gui)
+linkQt(scratchcpp-render)
 
 include(build/SetUpLibscratchcpp.cmake)
-target_link_libraries(libscratchcpp-gui PRIVATE scratchcpp)
+target_link_libraries(scratchcpp-render PRIVATE scratchcpp)
 
 add_subdirectory(thirdparty/libqnanopainter)
-target_include_directories(libscratchcpp-gui PRIVATE thirdparty/libqnanopainter)
-target_link_libraries(libscratchcpp-gui PRIVATE qnanopainter)
+target_include_directories(scratchcpp-render PRIVATE thirdparty/libqnanopainter)
+target_link_libraries(scratchcpp-render PRIVATE qnanopainter)
 
-if (SCRATCHCPPGUI_BUILD_UNIT_TESTS)
+if (SCRATCHCPPRENDER_BUILD_UNIT_TESTS)
     enable_testing()
     add_subdirectory(test)
 endif()

README.md

@@ -20,21 +20,21 @@
 <!-- PROJECT LOGO -->
 <br />
 <div align="center">
-  <!-- TODO: Add logo: <a href="https://github.com/scratchcpp/scratchcpp-gui">
+  <!-- TODO: Add logo: <a href="https://github.com/scratchcpp/scratchcpp-render">
     <img src="images/logo.png" alt="Logo" width="80" height="80">
   </a> -->
 
-<h3 align="center">ScratchCPP GUI</h3>
+<h3 align="center">ScratchCPP Render</h3>
 
   <p align="center">
     A Qt-based library which uses libscratchcpp and QNanoPainter to render running Scratch projects.
     <br />
-    <!-- TODO: Add link to documentation: <a href="https://github.com/scratchcpp/scratchcpp-gui"><strong>Explore the docs »</strong></a>
+    <!-- TODO: Add link to documentation: <a href="https://github.com/scratchcpp/scratchcpp-render"><strong>Explore the docs »</strong></a>
     <br /> -->
     <br />
-    <a href="https://github.com/scratchcpp/scratchcpp-gui/issues">Report Bug</a>
+    <a href="https://github.com/scratchcpp/scratchcpp-render/issues">Report Bug</a>
     ·
-    <a href="https://github.com/scratchcpp/scratchcpp-gui/issues">Request Feature</a>
+    <a href="https://github.com/scratchcpp/scratchcpp-render/issues">Request Feature</a>
   </p>
 </div>
 
@@ -62,7 +62,7 @@
 <!-- ABOUT THE PROJECT -->
 ## About The Project
 
-**scratchcpp-gui** is a library which provides a set of Qt Quick components that can be used to run Scratch projects.
+**scratchcpp-render** is a library which provides a set of Qt Quick components that can be used to run and render Scratch projects.
 
 It uses **QNanoPainter** on top of Qt for hardware accelerated rendering
 and **libscratchcpp** to read, run and maintain the state of Scratch projects.
@@ -88,10 +88,10 @@ We're working on the documentation, it'll be available soon.
 
 <!-- USAGE EXAMPLES -->
 ## Usage
-The most common way to get started is to use the `ProjectPlayer` component.
+Get started by using the `ProjectPlayer` component.
 ```qml
 import QtQuick
-import ScratchCPPGui
+import ScratchCPP.Render
 
 Window {
     width: 480
@@ -140,7 +140,7 @@ Button {
 - [ ] Speech and thought bubbles
 - [ ] Question text box ("ask and wait" block)
 
-See the [open issues](https://github.com/scratchcpp/scratchcpp-gui/issues) for a full list of proposed features (and known issues).
+See the [open issues](https://github.com/scratchcpp/scratchcpp-render/issues) for a full list of proposed features (and known issues).
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -176,13 +176,13 @@ Distributed under the GNU Lesser General Public License. See [LICENSE](LICENSE)
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-[contributors-shield]: https://img.shields.io/github/contributors/scratchcpp/scratchcpp-gui.svg?style=for-the-badge
-[contributors-url]: https://github.com/scratchcpp/scratchcpp-gui/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/scratchcpp/scratchcpp-gui.svg?style=for-the-badge
-[forks-url]: https://github.com/scratchcpp/scratchcpp-gui/network/members
-[stars-shield]: https://img.shields.io/github/stars/scratchcpp/scratchcpp-gui.svg?style=for-the-badge
-[stars-url]: https://github.com/scratchcpp/scratchcpp-gui/stargazers
-[issues-shield]: https://img.shields.io/github/issues/scratchcpp/scratchcpp-gui.svg?style=for-the-badge
-[issues-url]: https://github.com/scratchcpp/scratchcpp-gui/issues
-[license-shield]: https://img.shields.io/github/license/scratchcpp/scratchcpp-gui.svg?style=for-the-badge
-[license-url]: https://github.com/scratchcpp/scratchcpp-gui/blob/master/LICENSE
+[contributors-shield]: https://img.shields.io/github/contributors/scratchcpp/scratchcpp-render.svg?style=for-the-badge
+[contributors-url]: https://github.com/scratchcpp/scratchcpp-render/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/scratchcpp/scratchcpp-render.svg?style=for-the-badge
+[forks-url]: https://github.com/scratchcpp/scratchcpp-render/network/members
+[stars-shield]: https://img.shields.io/github/stars/scratchcpp/scratchcpp-render.svg?style=for-the-badge
+[stars-url]: https://github.com/scratchcpp/scratchcpp-render/stargazers
+[issues-shield]: https://img.shields.io/github/issues/scratchcpp/scratchcpp-render.svg?style=for-the-badge
+[issues-url]: https://github.com/scratchcpp/scratchcpp-render/issues
+[license-shield]: https://img.shields.io/github/license/scratchcpp/scratchcpp-render.svg?style=for-the-badge
+[license-url]: https://github.com/scratchcpp/scratchcpp-render/blob/master/LICENSE

build/FindQt.cmake

@@ -1,7 +1,7 @@
 find_package(Qt6 6.6 COMPONENTS Gui Qml Quick Svg REQUIRED)
 set(QT_LIBS Qt6::Gui Qt6::Qml Qt6::Quick Qt6::Svg)
 
-if (SCRATCHCPPGUI_BUILD_UNIT_TESTS)
+if (SCRATCHCPPRENDER_BUILD_UNIT_TESTS)
     find_package(Qt6 6.6 COMPONENTS Test REQUIRED)
 endif()
 

build/SetUpLibscratchcpp.cmake

@@ -1,3 +1,3 @@
 set(LIBSCRATCHCPP_BUILD_UNIT_TESTS OFF)
 add_subdirectory(${PROJECT_SOURCE_DIR}/libscratchcpp libscratchcpp)
-target_include_directories(libscratchcpp-gui PUBLIC ${PROJECT_SOURCE_DIR}/libscratchcpp/include)
+target_include_directories(scratchcpp-render PUBLIC ${PROJECT_SOURCE_DIR}/libscratchcpp/include)

ScratchCPPGui/CMakeLists.txt src/CMakeLists.txtScratchCPPGui/CMakeLists.txt renamed to src/CMakeLists.txt

@@ -1,10 +1,12 @@
-qt_add_library(libscratchcpp-gui STATIC)
+qt_add_library(scratchcpp-render STATIC)
 
-set_target_properties(libscratchcpp-gui PROPERTIES AUTOMOC ON)
+set_target_properties(scratchcpp-render PROPERTIES AUTOMOC ON)
 
-qt_add_qml_module(libscratchcpp-gui
-    URI ScratchCPPGui
+qt_add_qml_module(scratchcpp-render
+    URI ScratchCPP.Render
     VERSION 1.0
+    NO_PLUGIN
+    OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/ScratchCPP/Render
     QML_FILES
         ProjectPlayer.qml
     SOURCES
@@ -29,3 +31,7 @@ qt_add_qml_module(libscratchcpp-gui
 	keyeventhandler.cpp
 	keyeventhandler.h
 )
+
+list(APPEND QML_IMPORT_PATH ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR})
+list(REMOVE_DUPLICATES QML_IMPORT_PATH)
+set(QML_IMPORT_PATH ${QML_IMPORT_PATH} CACHE STRING "" FORCE)

ScratchCPPGui/ProjectPlayer.qml src/ProjectPlayer.qmlScratchCPPGui/ProjectPlayer.qml renamed to src/ProjectPlayer.qml

@@ -3,7 +3,7 @@
 import QtQuick
 import QtQuick.Layouts
 import QtQuick.Controls
-import ScratchCPPGui
+import ScratchCPP.Render
 
 ProjectScene {
     property string fileName