catrobat/godot_spike

Development Setup

Install All Development Dependencies

• Godot
  IMPORTANT: Needs to be in the path!
• rust (ideally latest stable version via rustup)
• just (cargo install just)
• gdtoolkit (pip install gdtoolkit)
  IMPORTANT: Needs to be in the path!
• pre-commit (pip install pre-commit)
• sh: included in Git Bash for Windows.
  IMPORTANT: Needs to be in the path!

For Windows Builds:

• mingw-w64, taken from here MinGW
  IMPORTANT: Needs to be in the path!

For Linux Builds:

• mold (distro repositories) recommended

Set up the Repository

just setup

This command will

• check whether all development dependencies are present and in $PATH
• generate development signing keys for Android
• install pre-commit hooks (automatic formatting and linting before a commit)
• install the necessary rust components

Manual Steps

Keystore

You need to set your android keystore to this file in godot. See:

https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_android.html#setting-it-up-in-godot

Plugins

You need to enable all the plugins, which we ship by default under Project -> Project Settings... -> Plugins -> Check Status Enable.

Exporting Project

In order to export the created project you need to download the template. There is a link under Project -> Export... if you don't have it installed yet.

Development

godot_spike's Issues

Use the AutoUpdate framework for Sprite

Rust: Use `cranelift` backend

https://github.com/rust-lang/rustc_codegen_cranelift

Make `Your Projects` opened by default

Use signals in Godot 4 style

Use signals in Godot 4 style -> without strings, which allows better error handling.

Implement MacOS export

Refactor folder/file structure

Implement export CI under Windows OS

DOD:

• Debug Export for Windows working

Update AST from Rust

Attempt to update AST in Godot from Rust using signals.

Add fragment selection to sprite

CI action for exporting project in Godot for Linux

CI action for exporting project in Godot for Linux: Android and Linux export.

Sprites Drag and Drop

Support multiple Sprites (with CodeGen)

Compiler: More code generation

CI: Do not redownload Android SDK on every run

Currently, every time the CI is run, the Android SDK is downloaded,
which takes long and a lot of ressources.

This should not happen.

Possible solution: Custom Docker Container

Automatically update Godot Version

iOS build Pipeline

Implement first test suite on frontend side

Implement test suite in Godot.
In future, add to test pipeline on GitHub actions.

Implement basic `set-sprite` command

Create temporary AST datastructure and add values from Godot

general drag and drop widget

Drag and drop tree

CI: Implement iOS export in MacOS

UI for adding number to AST and displaying

• Add Button for UI number add (testing purposes).
• Add New Sprite button.
• Implement file picker for adding sprite and show added sprite on stage.

Refactor Just file

Remove .godot folder from remote

Fully automate Android SDK installation

Blocked by godotengine/godot-proposals#9349

Set current blocks on update signal from Rust API

Execute GdScript from rust API

Implement adding script to script view and call run. Then fetch code from rust and execute on frontend.

GUI Tests: Create a List

• Gherkin format?

Test issue

Create dropdown menu for existing projects

Implement ProjectSelector screen

Implement project selector screen:

• Create new project
  • New project name
  • Submit
  • Shown in list when back button pressed
• All projects list
• Back button

Implement GitHub CI action for unit testing on frontend

Try to use `mold` as a Linker for faster build times

• Linux: https://github.com/rui314/mold
• MacOS/iOS: https://github.com/bluewhalesystems/sold

Available in the standard repos in Ubuntu & Arch

Connect Godot API with Compiler

Implement CI action for MacOS build

Rename some folders and files

Rename some folders and files according to official CS -> https://docs.godotengine.org/en/stable/tutorials/best_practices/project_organization.html.

Windows CI/CD GitHub action

Build: Web Export

Try to see whether a reasonable Web Export can be implemented.

• Godot: 4.3+ should support this
• GdExt: unclear, needs to be tried

Links/References:

• https://godotengine.org/article/progress-report-web-export-in-4-3/
• https://godot-rust.github.io/book/toolchain/export-web.html

Fix windows build

Fix windows build and refactor justfile in order to build and export android from windows.

CI: Implement release pipeline

Automate properly releasing the android apk to Google Play

Change x and y coordinate in move fragment

Change x and y coordinate in float and pass to Rust. Return move statement with the corresponding values and move sprite accordingly.

Add pre-commit task to setup in justfile

Use `sccache` to speed up repeated compilations

• not available in Ubuntu Repos
• can be installed with cargo install

Editor: Drag and Drop in Sublists

CI: Upload artifacts to GitHub

Upload artifacts to GitHub in order to download them.