Merge #1005

1005: Add a script for launching examples properly r=chitoyuu a=chitoyuu

Close #461

Co-authored-by: Chitose Yuuzaki <chitoyuu@potatoes.gay>

Author: bors[bot]

README.md

@@ -113,9 +113,7 @@ godot_init!(init);
 
 > **Important note:**
 >
-> Before launching the examples in the Godot editor, you must first run `cargo build` and wait for the build operations to finish successfully.
->
->At startup, the Godot editor tries to load all resources used by the project, including the native library. If the latter isn't present, the editor will skip properties or signals associated with the missing native scripts in the scene. This causes the scene tree to be non-functional for any sample that relies on properties or signals configured in the editor.
+> To run or edit an example, you need to build the native library for it first. Otherwise, the project will be broken. You can do so manually with `cargo build`, or use the `example.sh` shell script for convenience: `./example.sh run hello-world` or `./example.sh edit hello-world` for the editor.
 
 The [/examples](https://github.com/godot-rust/godot-rust/tree/master/examples) directory contains several ready to use examples, complete with Godot projects and setup for easy compilation from Cargo:
 
@@ -130,6 +128,7 @@ The [/examples](https://github.com/godot-rust/godot-rust/tree/master/examples) d
 - [**rpc**](https://github.com/godot-rust/godot-rust/tree/master/examples/rpc) - Simple peer-to-peer networking.
 - [**native-plugin**](https://github.com/godot-rust/godot-rust/tree/master/examples/native-plugin) - Create custom node plugins.
 
+At startup, the Godot editor tries to load all resources used by the project, including the native library. If the latter isn't present, the editor will skip properties or signals associated with the missing native scripts in the scene. This causes the scene tree to be non-functional for any sample that relies on properties or signals configured in the editor.
 ### Third-party projects
 
 To see a list of games and integrations developed on top of godot-rust, have a look at our list of [third-party projects](https://godot-rust.github.io/book/projects.html) in the book.

example.sh

@@ -0,0 +1,91 @@
+#!/bin/bash
+
+# Small utility to compile and run examples
+
+# No args specified: do everything
+if [ "$#" -eq 0 ]; then
+    args=("--help")
+else
+    args=("$@")
+fi
+
+# --help menu
+for arg in "${args[@]}"; do
+    if [ "$arg" == "--help" ]; then
+        echo "Usage: example.sh <command> <example-name>"
+        echo ""
+        echo "Commands:"
+        echo "    run           run the specified example"
+        echo "    edit          open the specified example in the editor"
+        echo ""
+        echo "Examples:"
+        echo "    example.sh run hello-world"
+        exit 0
+    fi
+done
+
+if [ "$#" -ne 2 ]; then
+    echo "Both the command and the name of the example are required."
+    exit 1
+fi
+
+function findGodot() {
+    # User-defined GODOT_BIN
+    if [ -n "$GODOT_BIN" ]; then
+        echo "Found GODOT_BIN env var ($GODOT_BIN)"
+        godotBin="$GODOT_BIN"
+
+    #  Executable in path
+    elif command -v godot &>/dev/null; then
+        echo "Found 'godot' executable"
+        godotBin="godot"
+
+    # Special case for Windows when there is a .bat file
+    # Also consider that 'cmd /c' would need 'cmd //c' (https://stackoverflow.com/q/21357813)
+    elif
+        # Godot returns 255 for older versions, but 0 for newer ones
+        godot.bat --version
+        [[ $? -eq 255 || $? -eq 0 ]]
+    then
+        echo "Found 'godot.bat' script"
+        godotBin="godot.bat"
+
+    # Error case
+    else
+        echo "Godot executable not found"
+        exit 2
+    fi
+}
+
+example_path="${BASH_SOURCE%/*}/examples/${args[1]}"
+
+if ! [[ -d "$example_path" ]]; then
+    echo "The example ${args[1]} is not found."
+    exit 2
+fi
+
+findGodot
+
+cmds=()
+
+case "${args[0]}" in
+run)
+    cmds+=("cargo build --manifest-path $example_path/Cargo.toml")
+    cmds+=("$godotBin --path $example_path")
+    ;;
+edit)
+    cmds+=("cargo build --manifest-path $example_path/Cargo.toml")
+    cmds+=("$godotBin -e --path $example_path")
+    ;;
+*)
+    echo "Unrecognized command '$arg'"
+    exit 2
+    ;;
+esac
+
+for cmd in "${cmds[@]}"; do
+    echo "> $cmd"
+    $cmd || {
+        exit 1
+    }
+done