Merge branch 'master' into jovan/script_instance_soundness

Author: Bromeon

.github/other/public-docs-token.txt

@@ -1 +1 @@
-MTFBQUZNN0NBME9ONTgzUVd0Um13UV9QMkFnSWk4RVA3ZU44cXplampMQVZzTm5wSlNaYU84V0FmdjM4bmVDN3RJMllCVzZGNk5WQUw5NEpUTAo=
+MTFBQUZNN0NBMHpNWHlZeVBFZUl1bl9kdm5NOUV3RkZlVll6RVhNeGpvaHFVR1pyd1BSWUxjQ3cyYzFlUnZmR2VRRDZBUjJWT0NpdTRRSWVuUgo=

ReadMe.md

@@ -9,44 +9,45 @@ _**[Website]** | **[Book][book]** | **[API Docs]** | [Discord] | [Mastodon] | [T
 [Godot] is an open-source game engine, whose version 4 has brought large-scale improvements.  
 Its _GDExtension_ API allows integrating third-party languages and libraries.
 
-> If you are looking for a Rust binding for Godot 3 (GDNative API), check out [`gdnative`].
+If you are looking for a Rust binding for Godot 3 (GDNative API), check out [`gdnative`].
 
 
 ## Philosophy
 
 The Rust binding is an alternative to GDScript, with a focus on type safety, scalability and performance.
 
-The primary goal of gdext is to provide a _**pragmatic Rust API**_ for game developers.
+The primary goal of gdext is to provide a [**pragmatic Rust API**][philosophy] for game developers.
 
 Recurring workflows should be simple and require minimal boilerplate. APIs are designed to be safe and idiomatic Rust wherever possible.
 Due to interacting with Godot as a C++ engine, we sometimes follow unconventional approaches to provide a good user experience.
 
 
 ## Development status
 
-The gdext library has evolved a lot during 2023 and is now in a usable state for smaller projects.
-However, it is still in an early stage and there are certain things to keep in mind.
+The gdext library has evolved a lot during 2023 and 2024 and is now in a usable state for smaller projects.
+However, there are still certain things to keep in mind.
 
-> **Warning**
+> [!WARNING]  
 > The public API introduces breaking changes from time to time. Most of these are motivated by new features and
 > improved ergonomics for existing ones. See also [API stability] in the book.
 
 **Features:** While most Godot features are available, some less commonly used ones are missing. See [#24] for an up-to-date overview.
-At this point, there is **no** support for Android, iOS or WASM. Contributions are very welcome!
+At this point, there is **no** support for [Android] or [iOS], and [WASM] is experimental. Contributions are very welcome!
 
 **Bugs:** Most undefined behavior related to the FFI layer has been ironed out, but there may still be occasional safety issues. Apart from that,
 new additions to the library are typically not feature-complete from the start, but become more robust with feedback and testing over time.
-To counter bugs, we have an elaborate CI suite including clippy, unit tests, engine integration tests and memory sanitizers.
+To counter bugs, we have an elaborate CI suite including clippy, unit tests, engine integration tests and memory sanitizers. Even hot-reload is tested!
 
 
 ## Getting started
 
 To dive into Rust development with gdext, check out [the godot-rust book][book]. The book is still under construction,
-but already includes a tutorial to set up a simple example.
+but already covers a Hello World setup as well as several more in-depth chapters.
 
 To consult the API reference, have a look at the online [API Docs].
 
-Furthermore, we provide a small example game in the [`examples/dodge-the-creeps` directory][dodge-the-creeps].
+Furthermore, we provide a small example game in the [`examples/dodge-the-creeps` directory][dodge-the-creeps].  
+The example [`examples/hot-reload`][hot-reload] demonstrates hot-reloading in the Godot editor.
 
 If you need help, join our [Discord] server and ask in the `#help-gdext` channel!
 
@@ -65,15 +66,20 @@ those changes available (and only those, no surrounding code).
 Contributions are very welcome! If you want to help out, see [`Contributing.md`](Contributing.md) for some pointers on getting started.
 
 [#24]: https://github.com/godot-rust/gdext/issues/24
-[`gdnative`]: https://github.com/godot-rust/gdnative
 [API Docs]: https://godot-rust.github.io/docs/gdext
 [API stability]: https://godot-rust.github.io/book/toolchain/compatibility.html#rust-api-stability
-[book]: https://godot-rust.github.io/book
+[Android]: https://github.com/godot-rust/gdext/issues/470
 [Discord]: https://discord.gg/aKUCJ8rJsc
-[dodge-the-creeps]: examples/dodge-the-creeps
 [Godot]: https://godotengine.org
 [Mastodon]: https://mastodon.gamedev.place/@GodotRust
-[mpl]: https://www.mozilla.org/en-US/MPL
 [Sponsor]: https://github.com/sponsors/Bromeon
 [Twitter]: https://twitter.com/GodotRust
+[WASM]: https://godot-rust.github.io/book/toolchain/export-web.html
 [Website]: https://godot-rust.github.io
+[`gdnative`]: https://github.com/godot-rust/gdnative
+[book]: https://godot-rust.github.io/book
+[dodge-the-creeps]: examples/dodge-the-creeps
+[hot-reload]: examples/hot-reload
+[iOS]: https://github.com/godot-rust/gdext/issues/498
+[mpl]: https://www.mozilla.org/en-US/MPL
+[philosophy]: https://godot-rust.github.io/book/contribute/philosophy.html

examples/hot-reload/godot/test/orchestrate.py

@@ -38,7 +38,7 @@ def send_udp():
 
 
 def receive_udp() -> bool:
-    timeout = 20
+    timeout = 30
     udp = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
     udp.bind(("localhost", 1338))
 

godot-macros/Cargo.toml

@@ -22,8 +22,7 @@ godot = { path = "../godot" }
 proc-macro2 = "1.0.63"
 quote = "1.0.29"
 
-venial = { git = "https://github.com/PoignardAzur/venial", rev = "32ade31408eb0ffba4ce7b02d3cdb2e78b496644" }
-#venial = "0.5"
+venial = "0.6"
 
 [build-dependencies]
 godot-bindings = { path = "../godot-bindings" } # emit_godot_version_cfg

godot/src/lib.rs

@@ -13,7 +13,7 @@
 //!
 //! Godot is written in C++, which doesn't have the same strict guarantees about safety and
 //! mutability that Rust does. As a result, not everything in this crate will look and feel
-//! entirely "rusty".
+//! entirely "rusty". See also [Philosophy](https://godot-rust.github.io/book/contribute/philosophy.html).
 //!
 //! Traits such as `Clone`, `PartialEq` or `PartialOrd` are designed to mirror Godot semantics,
 //! except in cases where Rust is stricter (e.g. float ordering). Cloning a type results in the
@@ -43,8 +43,7 @@
 //!    from [`RefCounted`][crate::engine::RefCounted].
 //!
 //!    These types may share their underlying data between multiple instances: changes to one
-//!    instance are visible in another. Think of them as `Rc<RefCell<...>>` but without any runtime
-//!    borrow checking.
+//!    instance are visible in another. They are conceptually similar to `Rc<RefCell<...>>`.
 //!
 //!    Since there is no way to prevent or even detect this sharing from Rust, you need to be more
 //!    careful when using such types. For example, when iterating over an `Array`, make sure that