Merge pull request #73 from MisterGC/feature/multi-sbx-support

Feature/multi sbx support
MisterGC · Aug 26, 2021 · cdf2d85 · cdf2d85
2 parents 06cf615 + 02a6d32
commit cdf2d85
Show file tree

Hide file tree

Showing 81 changed files with 388 additions and 362 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -25,15 +25,9 @@ add_subdirectory (thirdparty/qml-box2d)
 add_subdirectory (thirdparty/simple-svg-writer)
 add_subdirectory (plugins)
 
+# Qt has problems with multiple executables when building for Android
+# TODO Re-check if support for Android got better in Qt6
 if(NOT ANDROID)
-    add_subdirectory (liveloader)
-endif()
-
-if(NOT ANDROID)
-    add_subdirectory (sandboxes/gui)
-    add_subdirectory (sandboxes/visualfx)
-    add_subdirectory (sandboxes/platformer)
-    add_subdirectory (sandboxes/pluginlive)
-    add_subdirectory (sandboxes/topdown)
-    add_subdirectory (sandboxes/void)
+    add_subdirectory (tools)
+    add_subdirectory (examples)
 endif()
diff --git a/README.md b/README.md
@@ -2,28 +2,32 @@
 
 
 
-## Flow, form, create 
+## Overview: Flow, Form, Create 
 When participating at [Ludum Dare 44](https://ldjam.com) I started to develop
-utilities and a LiveLoading app to ease game creation. As I really enjoyed
-using these components, I decided to create separate project and make it
+utilities and a live loading app to ease game creation. As I really enjoyed
+using these components, I decided to create a separate project and to make it
 open source.
 
 Clayground is a [Qt](https://www.qt.io) based toolset that allows using C++, JavaScript
-and [QML](https://doc.qt.io/qt-5/qtqml-index.html) to rapidly develop apps in a sandbox environment with live loading capabilities.
-It provides tools that try both facilitating learning and allowing more
-focused and faster development by reducing typical build and restart times
-significantly.
+and [QML](https://doc.qt.io/qt-5/qtqml-index.html) to rapidly develop apps in a sandbox
+environment with live loading capabilities.  It provides tools that try both, facilitating
+learning and allowing more focused and faster development by reducing typical build and restart times significantly.
 
 ![Platformer Screenshot](res/screenshot_platformer.png)
 
 Goals/Basic Design Decisions:
-- Use Qt (Quick): Don't write everything from scratch, but think how to re-combine Qt's capabilities 
-- Code > Graphical Tools: Focus on minimizing time needed to write and debug applications
-- Don't write graphical tools, but support formats which can be used with popular free tools 
-- Add dedicated APIs but still allow bypassing them (full power of Qt/Qml, C++, JavaScript)
-- Target (rapid) prototyping and small/medium app development
-
-### Available Plugins
+- Target Scope: Optimize for (rapid) prototyping and small/medium app development
+- Focus on written source code and keyboard actions not for usage of graphical tools
+- Full control: Add dedicated APIs but allow bypassing them easily (full power of C++, Qt/Qml, JavaScript)
+- Don't provide (graphical) tools: Go for approaches that allow usage of freely available, popular tools like Qt Creator, Git and Inkscape
+- Qt as Foundation: Don't write everything from scratch, but think how to re-combine Qt's capabilities 
+
+Main components:
+- **Dojo**: Sandbox environment which is designed to be used for rapid dev, it is typically put next to a code editor/IDE, code changes are automatically applied 
+- **Plugins**: Different packages that can be used to build (interactive) apps
+- **Examples**: Demonstrate the usage of Clayground, all examples can be either used with Dojo or standalone
+
+### Plugins: Clayground's basic building blocks
 Clayground comes with a set of plugins that extend Qt capabilities in order to
 build interactive experiences:
 - Physics/Box2D: Adds 2D Physics capabilities
@@ -34,40 +38,40 @@ build interactive experiences:
 - Storage: Get persistent storage with a very simple API
 - World: Uses Canvas, Physics and SVG to provide a foundation for small games and simulations
 
-### Available Examples
+### Examples: See how problems can be solved with Clayground
 A bunch of example application allow you to try it out easily:
 - GUI: Visual training app for keyboard shortcuts, comes with a configuration for Inkscape.
 - VisualFX: Implementation of different visual effects, includes usage of the [Qt Particle System](https://doc.qt.io/qt-5/qtquick-effects-particles.html).
 - Platformer: Starting point for a platformer game.
-- TopDown: Starting point for a topdown game (for example a classical RPG).
-- PluginLive: Demonstrates how to use the Clayground LiveLoader to develop a C++ plugin.
+- TopDown: Starting point for a topdown game (for example a classical RPG), comes with network support 
+- PluginLive: Demonstrates how to use the Clayground LiveLoader to develop a C++ plugin
 
 ### How to work with a sandbox?
 1. Clone this repo and build it (Qt 5.15.x, Qt Creator)
-2. Start the qml_live_loader app `clayrestarter --dynimportdir=<clone-dir>/sandboxes/void`
+2. Start the dojo app `claydojo --sbx=<clone-dir>/sandboxes/void/Sandbox.qml`
 3. Move the window to a location that allows you to keep it visible even when your are editing code.
-4. Make changes to `<clone-dir>/sandboxes/void/Sandbox.qml` -> see the changes live applied
-5. Check out the other sandboxes in the same way :)
+4. Make changes to `<clone-dir>/sandboxes/void/Sandbox.qml` -> see the changes applied automatically
+5. Press `G` in the app window to show the Guide/Help overlay.
+6. Check out the other sandboxes in the same way :)
+
 
 #### Using the Logging Overlay
-The sandbox comes with a logging overlay that shows all 
-`console.log(...)` messages in a continous log view and 
-watched properties/expressions in a sticky section. You can 
-easily show/hide the overlay by using the `log` button of the 
-restarter or by pressing lower-case L when the Sbx Window has the focus.
+The sandbox comes with a logging overlay that shows all `console.log(...)` messages in a continous log view and watched properties/expressions in a sticky section. You can 
+easily show/hide the logging overlay by pressing `L` when the Sandbox Window has the focus.
 
 <img src="res/log_overlay.png" width="50%" height="50%" alt="LogOverlay Screenshot">
 
-Have a look at the `onMapLoaded` signal handler of the Platformer 
-Sandbox to see how you can use them.
+Have a look at the `onMapLoaded` signal handler of the Platformer Sandbox to see how you can use them.
 
 ### How to create a deployable app?
 Each of the demo sandboxes also comes with a CMake application configuration which 
 allows to build a standalone app. So you can just use one as a template to build your own app.
 
 ### Is there any recommended development setup?
 - OS: Linux (fastest and easy to use) - I have also used it on macOS and Windows 10, still good but use Linux if you can 
-- IDE/Editor: Qt Creator as it also allows you to easily debug and profile resulting apps - additionally I use Vim for various text processing tasks
+- IDE/Editor: Qt Creator as it also allows you to easily debug and profile resulting apps - additionally I use Vim and VS Code for various text processing tasks
 
+Feel free to contact me, create issues or to contribute :)
 
-I hope you enjoy using clayground, feel free to create issues or to contribute :)
+Enjoy life,<br>
+`mgc`
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -0,0 +1,9 @@
+cmake_minimum_required(VERSION 3.16)
+project (examples)
+
+add_subdirectory (gui)
+add_subdirectory (visualfx)
+add_subdirectory (platformer)
+add_subdirectory (pluginlive)
+add_subdirectory (topdown)
+add_subdirectory (void)
diff --git a/sandboxes/gui/CMakeLists.txt → examples/gui/CMakeLists.txt b/sandboxes/gui/CMakeLists.txt → examples/gui/CMakeLists.txt
diff --git a/sandboxes/gui/Sandbox.qml → examples/gui/Sandbox.qml b/sandboxes/gui/Sandbox.qml → examples/gui/Sandbox.qml
diff --git a/sandboxes/gui/Scoreboard.qml → examples/gui/Scoreboard.qml b/sandboxes/gui/Scoreboard.qml → examples/gui/Scoreboard.qml
diff --git a/sandboxes/gui/ShortcutChecker.qml → examples/gui/ShortcutChecker.qml b/sandboxes/gui/ShortcutChecker.qml → examples/gui/ShortcutChecker.qml
diff --git a/sandboxes/gui/TrainingDb.qml → examples/gui/TrainingDb.qml b/sandboxes/gui/TrainingDb.qml → examples/gui/TrainingDb.qml
diff --git a/sandboxes/gui/inkscape.xml → examples/gui/inkscape.xml b/sandboxes/gui/inkscape.xml → examples/gui/inkscape.xml
diff --git a/sandboxes/gui/main.cpp → examples/gui/main.cpp b/sandboxes/gui/main.cpp → examples/gui/main.cpp
diff --git a/sandboxes/gui/main.qml → examples/gui/main.qml b/sandboxes/gui/main.qml → examples/gui/main.qml
diff --git a/sandboxes/gui/res.qrc → examples/gui/res.qrc b/sandboxes/gui/res.qrc → examples/gui/res.qrc
diff --git a/sandboxes/gui/visuals.svg → examples/gui/visuals.svg b/sandboxes/gui/visuals.svg → examples/gui/visuals.svg
diff --git a/sandboxes/platformer/CMakeLists.txt → examples/platformer/CMakeLists.txt b/sandboxes/platformer/CMakeLists.txt → examples/platformer/CMakeLists.txt
diff --git a/sandboxes/platformer/JnRPlayer.qml → examples/platformer/JnRPlayer.qml b/sandboxes/platformer/JnRPlayer.qml → examples/platformer/JnRPlayer.qml
diff --git a/sandboxes/platformer/Player.qml → examples/platformer/Player.qml b/sandboxes/platformer/Player.qml → examples/platformer/Player.qml
diff --git a/sandboxes/platformer/Sandbox.qml → examples/platformer/Sandbox.qml b/sandboxes/platformer/Sandbox.qml → examples/platformer/Sandbox.qml
diff --git a/sandboxes/platformer/Wall.qml → examples/platformer/Wall.qml b/sandboxes/platformer/Wall.qml → examples/platformer/Wall.qml
diff --git a/sandboxes/platformer/WoodenBox.qml → examples/platformer/WoodenBox.qml b/sandboxes/platformer/WoodenBox.qml → examples/platformer/WoodenBox.qml
diff --git a/sandboxes/platformer/main.cpp → examples/platformer/main.cpp b/sandboxes/platformer/main.cpp → examples/platformer/main.cpp
diff --git a/sandboxes/platformer/main.qml → examples/platformer/main.qml b/sandboxes/platformer/main.qml → examples/platformer/main.qml
diff --git a/sandboxes/platformer/map.svg → examples/platformer/map.svg b/sandboxes/platformer/map.svg → examples/platformer/map.svg
diff --git a/sandboxes/platformer/res.qrc → examples/platformer/res.qrc b/sandboxes/platformer/res.qrc → examples/platformer/res.qrc
diff --git a/sandboxes/platformer/visuals.svg → examples/platformer/visuals.svg b/sandboxes/platformer/visuals.svg → examples/platformer/visuals.svg
diff --git a/sandboxes/pluginlive/CMakeLists.txt → examples/pluginlive/CMakeLists.txt b/sandboxes/pluginlive/CMakeLists.txt → examples/pluginlive/CMakeLists.txt
diff --git a/sandboxes/pluginlive/Sandbox.qml → examples/pluginlive/Sandbox.qml b/sandboxes/pluginlive/Sandbox.qml → examples/pluginlive/Sandbox.qml
diff --git a/sandboxes/pluginlive/main.cpp → examples/pluginlive/main.cpp b/sandboxes/pluginlive/main.cpp → examples/pluginlive/main.cpp
diff --git a/sandboxes/pluginlive/main.qml → examples/pluginlive/main.qml b/sandboxes/pluginlive/main.qml → examples/pluginlive/main.qml
diff --git a/sandboxes/pluginlive/plugin/CMakeLists.txt → examples/pluginlive/plugin/CMakeLists.txt b/sandboxes/pluginlive/plugin/CMakeLists.txt → examples/pluginlive/plugin/CMakeLists.txt
diff --git a/sandboxes/pluginlive/plugin/mycomponent.cpp → examples/pluginlive/plugin/mycomponent.cpp b/sandboxes/pluginlive/plugin/mycomponent.cpp → examples/pluginlive/plugin/mycomponent.cpp
diff --git a/sandboxes/pluginlive/plugin/mycomponent.h → examples/pluginlive/plugin/mycomponent.h b/sandboxes/pluginlive/plugin/mycomponent.h → examples/pluginlive/plugin/mycomponent.h
diff --git a/sandboxes/pluginlive/plugin/myplugin.cpp → examples/pluginlive/plugin/myplugin.cpp b/sandboxes/pluginlive/plugin/myplugin.cpp → examples/pluginlive/plugin/myplugin.cpp
diff --git a/sandboxes/pluginlive/plugin/myplugin.h → examples/pluginlive/plugin/myplugin.h b/sandboxes/pluginlive/plugin/myplugin.h → examples/pluginlive/plugin/myplugin.h
diff --git a/sandboxes/pluginlive/plugin/qmldir.in → examples/pluginlive/plugin/qmldir.in b/sandboxes/pluginlive/plugin/qmldir.in → examples/pluginlive/plugin/qmldir.in
diff --git a/sandboxes/pluginlive/res.qrc → examples/pluginlive/res.qrc b/sandboxes/pluginlive/res.qrc → examples/pluginlive/res.qrc
diff --git a/sandboxes/topdown/CMakeLists.txt → examples/topdown/CMakeLists.txt b/sandboxes/topdown/CMakeLists.txt → examples/topdown/CMakeLists.txt
diff --git a/sandboxes/topdown/Player.qml → examples/topdown/Player.qml b/sandboxes/topdown/Player.qml → examples/topdown/Player.qml
diff --git a/sandboxes/topdown/Sandbox.qml → examples/topdown/Sandbox.qml b/sandboxes/topdown/Sandbox.qml → examples/topdown/Sandbox.qml
diff --git a/sandboxes/topdown/Wall.qml → examples/topdown/Wall.qml b/sandboxes/topdown/Wall.qml → examples/topdown/Wall.qml
diff --git a/sandboxes/topdown/main.cpp → examples/topdown/main.cpp b/sandboxes/topdown/main.cpp → examples/topdown/main.cpp
diff --git a/sandboxes/topdown/main.qml → examples/topdown/main.qml b/sandboxes/topdown/main.qml → examples/topdown/main.qml
diff --git a/sandboxes/topdown/map.svg → examples/topdown/map.svg b/sandboxes/topdown/map.svg → examples/topdown/map.svg
diff --git a/sandboxes/topdown/res.qrc → examples/topdown/res.qrc b/sandboxes/topdown/res.qrc → examples/topdown/res.qrc
diff --git a/sandboxes/visualfx/AbsorptionFx.qml → examples/visualfx/AbsorptionFx.qml b/sandboxes/visualfx/AbsorptionFx.qml → examples/visualfx/AbsorptionFx.qml
diff --git a/sandboxes/visualfx/CMakeLists.txt → examples/visualfx/CMakeLists.txt b/sandboxes/visualfx/CMakeLists.txt → examples/visualfx/CMakeLists.txt
diff --git a/sandboxes/visualfx/ExplosionFx.qml → examples/visualfx/ExplosionFx.qml b/sandboxes/visualfx/ExplosionFx.qml → examples/visualfx/ExplosionFx.qml
diff --git a/sandboxes/visualfx/Sandbox.qml → examples/visualfx/Sandbox.qml b/sandboxes/visualfx/Sandbox.qml → examples/visualfx/Sandbox.qml
diff --git a/sandboxes/visualfx/explosion.png → examples/visualfx/explosion.png b/sandboxes/visualfx/explosion.png → examples/visualfx/explosion.png
diff --git a/sandboxes/visualfx/main.cpp → examples/visualfx/main.cpp b/sandboxes/visualfx/main.cpp → examples/visualfx/main.cpp
diff --git a/sandboxes/visualfx/main.qml → examples/visualfx/main.qml b/sandboxes/visualfx/main.qml → examples/visualfx/main.qml
diff --git a/sandboxes/visualfx/res.qrc → examples/visualfx/res.qrc b/sandboxes/visualfx/res.qrc → examples/visualfx/res.qrc
diff --git a/sandboxes/void/CMakeLists.txt → examples/void/CMakeLists.txt b/sandboxes/void/CMakeLists.txt → examples/void/CMakeLists.txt
diff --git a/sandboxes/void/Sandbox.qml → examples/void/Sandbox.qml b/sandboxes/void/Sandbox.qml → examples/void/Sandbox.qml
diff --git a/sandboxes/void/main.cpp → examples/void/main.cpp b/sandboxes/void/main.cpp → examples/void/main.cpp
diff --git a/sandboxes/void/main.qml → examples/void/main.qml b/sandboxes/void/main.qml → examples/void/main.qml
diff --git a/sandboxes/void/res.qrc → examples/void/res.qrc b/sandboxes/void/res.qrc → examples/void/res.qrc
diff --git a/liveloader/CMakeLists.txt b/liveloader/CMakeLists.txt
diff --git a/liveloader/loader/main.qml b/liveloader/loader/main.qml
diff --git a/liveloader/restarter/graphics.svg b/liveloader/restarter/graphics.svg
diff --git a/tools/CMakeLists.txt b/tools/CMakeLists.txt
@@ -0,0 +1,6 @@
+cmake_minimum_required(VERSION 3.16)
+project (clayground_tools)
+
+add_subdirectory (common)
+add_subdirectory (dojo)
+add_subdirectory (loader)
diff --git a/liveloader/utils/CMakeLists.txt → tools/common/CMakeLists.txt b/liveloader/utils/CMakeLists.txt → tools/common/CMakeLists.txt
@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.16)
-project (clayutilities)
+project (claytoolscommon)
 
 import_qt_components(Core)
 

diff --git a/liveloader/utils/clayfilesysobserver.cpp → tools/common/clayfilesysobserver.cpp b/liveloader/utils/clayfilesysobserver.cpp → tools/common/clayfilesysobserver.cpp
diff --git a/liveloader/utils/clayfilesysobserver.h → tools/common/clayfilesysobserver.h b/liveloader/utils/clayfilesysobserver.h → tools/common/clayfilesysobserver.h
diff --git a/liveloader/utils/utilityfunctions.cpp → tools/common/utilityfunctions.cpp b/liveloader/utils/utilityfunctions.cpp → tools/common/utilityfunctions.cpp
@@ -6,5 +6,7 @@ void addCommonArgs(QCommandLineParser &parser)
 {
     parser.addOption({DYN_PLUGIN_ARG, DYN_PLUGIN_ARG_DESCR, "directory-pair"});
     parser.addOption({DYN_IMPORT_DIR_ARG, DYN_IMPORT_DIR_ARG_DESCR, "directory", "<working directory>"});
+    parser.addOption({SBX_ARG, SBX_ARG_DESCR, "file-path", "<none>"});
+    parser.addOption({SBX_INDEX_ARG, SBX_INDEX_ARG_DESCR, "index", QString::number(USE_FIRST_SBX_IDX)});
     parser.addOption({MESSAGE_ARG, MESSAGE_ARG_DESCR, "N/A"});
 }