Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added note regarding .obj file in some rust target builds causing God… #12

Merged
merged 5 commits into from
Nov 17, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/intro/hello-world.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,13 @@ The main crate of gdext is called `godot`. At this point, it is still hosted on
To fetch the latest changes, you can regularly run a `cargo update` (possibly breaking). Keep your `Cargo.lock` file under version control,
so that it's easy to revert updates.

```admonish note
JamFactoryInc marked this conversation as resolved.
Show resolved Hide resolved
It may be a advisable to put a [.gdignore][gd-ignore] file at the top-level of your rust project directory or within your `/target` dir.
This is because for some Windows build targets, `cargo build` produces an object file with the `.obj` extension rather than the typical `.o`
JamFactoryInc marked this conversation as resolved.
Show resolved Hide resolved
Godot will attempt to import this compiled binary as an Wavefront OBJ file (a common 3D model file, also using the extension `.obj`),
and will fail to build due to a 'corrupted file' error.
```


## Rust entry point

Expand Down Expand Up @@ -332,3 +339,4 @@ That's it for the _Hello World_ tutorial! The following chapters will go into mo
[sprite2d-api]: https://godot-rust.github.io/docs/gdext/master/godot/engine/struct.Sprite2D.html
[tutorial-begin]: https://docs.godotengine.org/en/stable/getting_started/step_by_step/scripting_first_script.html
[tutorial-full-script]: https://docs.godotengine.org/en/stable/getting_started/step_by_step/scripting_first_script.html#complete-script
[gd-ignore]: https://docs.godotengine.org/en/stable/tutorials/best_practices/project_organization.html#ignoring-specific-folders
Loading