Tools Recipes #23

QueenOfSquiggles · 2024-01-06T20:06:56Z

This PR adds a section dedicated to describing how to get started with tooling using godot-rust. Specifically the three main categories available to the average developer:

Simple Types: defining custom Object, Resource, and Node types for the end-user
EditorPlugin: creating an EditorPlugin type for typical plugin development
Engine Singletons: creating an "always on" singleton easily available to GDScript

The guides go over why each method is valuable and how to implement them, with recommendations and callouts for specific pitfalls where necessary.

I have no doubt I made some mistakes so far, but this is just an initial commit. Excited to hear what y'all think

QueenOfSquiggles · 2024-01-06T20:07:35Z

I just realized I accidentally merged the admonish stuff which messed with the TOML

QueenOfSquiggles · 2024-01-06T20:10:49Z

Working on lint issues

Bromeon · 2024-01-06T20:13:18Z

💡 You can auto-fix some of the lints, see ReadMe and lint.sh script.

QueenOfSquiggles · 2024-01-06T20:40:26Z

I don't imagine I'd add the gdscript highlighting in this PR. I'm also struggling to figure out how to add it to mdbook so I'd have to do some digging to figure that out.

Bromeon · 2024-01-06T20:47:08Z

All good, we can always add it later 🙂 also, would deserve its own PR anyway...

QueenOfSquiggles · 2024-01-08T17:16:27Z

Following up on this PR, is there a plan to merge? Does it require a review? Anything I can do? If y'all want me to make some edits I'd be happy to do so. Just wanna know the plan

Bromeon

Thanks a lot! 👍

I gave quite some feedback. In general, I'm sometimes a bit nitpicky about precise formulations 😬 but since this is tutorial-level material, it's quite important that terminology is clear and unambiguous, and that we use full sentences where possible (sometimes even in comments). But my comments are mostly technicalities, the content itself is great!

book.code-workspace

src/SUMMARY.md

src/tooling/index.md

src/tooling/tooling-simple-types.md

Bromeon

Would also be good to have all the code snippets run through rustfmt 🧹

src/tooling/tooling-simple-types.md

QueenOfSquiggles · 2024-01-08T20:19:43Z

I took a breeze through the review and answered. Im gonna spend a few hours cleaning this up once I've got myself some tea

QueenOfSquiggles

I just pushed a version taking your recommendations into consideration, which did constitute drastic changes to two (one being created) files.

QueenOfSquiggles · 2024-01-08T21:43:54Z

dangit forgot license and lint again 😩

QueenOfSquiggles · 2024-01-08T22:07:47Z

I wager another round of review might be needed. But hopefully this is cleaner and more readable than before!

Bromeon

Thanks for the update! 🙂

General points:

Titles do not get special capitalization, but follow English grammar (just first word and names like "Rust" or "Godot" are capitalized).
Avoid "tooling", as mentioned before.
The writing style should generally be objective and not too opinionated, I mentioned a few instances 🙂
If you see a "Suggested change" diff in a review comment, you can directly apply it via the web UI. This saves you from manually needing to rewrite things, and makes sure all my suggestions are included.
Links should ideally be expanded at the end of the page, not inline.

Sorry for the extra work -- maybe next time, it's better to submit only one page at a time, and then apply the suggestions there to more writing before submitting additional PRs. Either way, thanks a lot! 👍

src/SUMMARY.md

src/recipes/tooling-custom-resources.md

src/recipes/tooling-engine-singleton.md

QueenOfSquiggles · 2024-01-10T14:18:23Z

I'll have a deeper look through the review later today

Bromeon · 2024-01-11T10:28:30Z

Thanks for the updates. Could you rebase this onto lastest master? There are now lots of commits from my changes showing up, which makes review harder.

Also, please ping me once the next round is ready for review -- no rush though! 🙂

QueenOfSquiggles · 2024-01-11T14:31:43Z

@Bromeon as far as I can tell my latest commit (Linting pt 2 #40d62b9) is already rebased with the latest commits on this repo applied. Let me know if there's anything more I can/should do

MarkWilds · 2024-01-13T09:22:06Z

This is amazing! great job. Do you also know how to implement the "handles" function in rust?

edit
I think I found a way:
pub fn class_name() -> ClassName { ClassName::from_ascii_cstr("WildVoxelMap".as_bytes()) }
That is what I have to implement in my GodotClass

QueenOfSquiggles · 2024-01-13T17:04:02Z

This is amazing! great job. Do you also know how to implement the "handles" function in rust?

edit I think I found a way: pub fn class_name() -> ClassName { ClassName::from_ascii_cstr("WildVoxelMap".as_bytes()) } That is what I have to implement in my GodotClass

I appreciate your interest in learning! But I don't think this is the best forum for that kind of question. I'd recommend the godot-rust discord server, specifically the "#help-gdext" channel which is for floating those kinds of questions to the community. Best of luck!

Bromeon

Thanks, almost there 🙂

I rebased onto master and squashed the 36 commits (29 without mine) to 1.

Bromeon · 2024-01-13T17:11:03Z

.gitignore

Why is this needed? The css should not be in the root.

Also, what is *.code-workspace?
VS Code's directory is typically .vscode, no?

That keeps happening because mdbook refuses to serve without running mdbook-admonish install. To check my edits I have to cause issues to the toml and then clear it out to push. Must have missed that.

as for *.code-workspace, that's the file type for defining workspace settings overrides. I use it to force wrap at 150 characters, so I can easily see where to make line breaks.

Bromeon · 2024-01-13T17:21:17Z

src/recipes/custom-icons.md

+```admonish hint
+Note that the path is based off of the `res://` path, like all other resources for Godot.
+This means that you will need to have a standard 
+installation path for your tool. It is recommended to make this in the "addons" folder because 
+this will clearly signify to users that it is a 
+directory of third party resources and code and that they likely shouldn't mess 
+with it unless they are certain of what they are doing.
+```


Something is off with the line lengths here, maybe you accidentally broke them too early?

Also, is addons/ actually an established convention? If yes, is there some documentation for it?

I'll have to check those lines in my editor

From the basis that GDScript plugins must be installed into the addons/ folder, it seems reasonable (to me) that we suggest addons/ as the folder for GDExtension by default, especially if writing using EditorPlugin to do typical plugin modifications to the editor interface and such. It also cleans things up for redistribution because the end user doesn't necessarily need to know that the plugin is written in rust rather than gdscript in order to install correctly. Though if you want this to be changed to be less opinionated I can make that change

Makes sense in that case!

Could you insert a link to the docs where this addons for GDScript is explained?

I just pushed a commit with a link to the "Installing Plugins" page of the docs, which includes a callout detailing how to tell if something is a plugin. I'd argue that section should be updated to include .gdextension files, but one step at a time

src/recipes/custom-resources.md

src/recipes/engine-singleton.md

src/recipes/tooling-engine-singleton.md

src/recipes/custom-icons.md

Co-authored-by: Jan Haller <[email protected]>

QueenOfSquiggles

I'm just awaiting further change requests on this. And some verification on if certain changes are needed.

Bromeon

I think we're slowly getting there, thanks for the quick update! 🙂

src/recipes/custom-icons.md

src/recipes/editor-plugin.md

src/recipes/index.md

Co-authored-by: Jan Haller <[email protected]>

QueenOfSquiggles

Got another round of fixes done

Bromeon · 2024-01-14T07:28:39Z

Really nice addition. Thanks for all the corrections and the patience! 🙂

Bromeon added the new-topic New content added to the book label Jan 6, 2024

Bromeon linked an issue Jan 6, 2024 that may be closed by this pull request

New Topic: Tooling Resources #22

Closed

Bromeon reviewed Jan 8, 2024

View reviewed changes

src/tooling/tooling-simple-types.md Outdated Show resolved Hide resolved

src/tooling/tooling-simple-types.md Outdated Show resolved Hide resolved

src/tooling/tooling-simple-types.md Outdated Show resolved Hide resolved

QueenOfSquiggles commented Jan 8, 2024

View reviewed changes

Bromeon reviewed Jan 10, 2024

View reviewed changes

QueenOfSquiggles changed the title ~~Tooling Guide Section~~ Tools Recipes Jan 10, 2024

Bromeon force-pushed the squiggles-tooling-section branch from 40d62b9 to 7fa58ab Compare January 13, 2024 17:18

Add recipes

4ef90d8

Bromeon force-pushed the squiggles-tooling-section branch from 7fa58ab to 4ef90d8 Compare January 13, 2024 17:20

Bromeon reviewed Jan 13, 2024

View reviewed changes

QueenOfSquiggles and others added 5 commits January 13, 2024 12:36

Update src/recipes/custom-resources.md

04e8b76

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/custom-icons.md

60793dc

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/custom-resources.md

8c902b6

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/engine-singleton.md

dcb69d4

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/engine-singleton.md

0d45a32

Co-authored-by: Jan Haller <[email protected]>

QueenOfSquiggles and others added 3 commits January 13, 2024 12:40

Update src/recipes/editor-plugin.md

3338b29

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/editor-plugin.md

f61a4c8

Co-authored-by: Jan Haller <[email protected]>

Initial changes per review. Awaiting further review

3e4782b

QueenOfSquiggles commented Jan 13, 2024

View reviewed changes

Added link to Godot Docs on Plugins

e7e5e56

Bromeon reviewed Jan 13, 2024

View reviewed changes

src/recipes/custom-icons.md Outdated Show resolved Hide resolved

src/recipes/custom-icons.md Outdated Show resolved Hide resolved

src/recipes/editor-plugin.md Outdated Show resolved Hide resolved

src/recipes/index.md Outdated Show resolved Hide resolved

QueenOfSquiggles and others added 3 commits January 13, 2024 15:32

Update src/recipes/editor-plugin.md

7e7056d

Co-authored-by: Jan Haller <[email protected]>

Update src/recipes/index.md

70e4ee6

Co-authored-by: Jan Haller <[email protected]>

Custom icons changes

0a7f882

QueenOfSquiggles commented Jan 13, 2024

View reviewed changes

Bromeon merged commit ddcf2c0 into godot-rust:master Jan 14, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tools Recipes #23

Tools Recipes #23

QueenOfSquiggles commented Jan 6, 2024

QueenOfSquiggles commented Jan 6, 2024

QueenOfSquiggles commented Jan 6, 2024

Bromeon commented Jan 6, 2024 •

edited

Loading

QueenOfSquiggles commented Jan 6, 2024

Bromeon commented Jan 6, 2024

QueenOfSquiggles commented Jan 8, 2024

Bromeon left a comment

Bromeon left a comment

QueenOfSquiggles commented Jan 8, 2024

QueenOfSquiggles left a comment

QueenOfSquiggles commented Jan 8, 2024

QueenOfSquiggles commented Jan 8, 2024

Bromeon left a comment

QueenOfSquiggles commented Jan 10, 2024

Bromeon commented Jan 11, 2024

QueenOfSquiggles commented Jan 11, 2024

MarkWilds commented Jan 13, 2024 •

edited

Loading

QueenOfSquiggles commented Jan 13, 2024

Bromeon left a comment

Bromeon Jan 13, 2024

QueenOfSquiggles Jan 13, 2024

Bromeon Jan 13, 2024

Bromeon Jan 13, 2024

QueenOfSquiggles Jan 13, 2024

Bromeon Jan 13, 2024

QueenOfSquiggles Jan 13, 2024

QueenOfSquiggles left a comment

Bromeon left a comment

QueenOfSquiggles left a comment

Bromeon commented Jan 14, 2024

Tools Recipes #23

Tools Recipes #23

Conversation

QueenOfSquiggles commented Jan 6, 2024

QueenOfSquiggles commented Jan 6, 2024

QueenOfSquiggles commented Jan 6, 2024

Bromeon commented Jan 6, 2024 • edited Loading

QueenOfSquiggles commented Jan 6, 2024

Bromeon commented Jan 6, 2024

QueenOfSquiggles commented Jan 8, 2024

Bromeon left a comment

Choose a reason for hiding this comment

Bromeon left a comment

Choose a reason for hiding this comment

QueenOfSquiggles commented Jan 8, 2024

QueenOfSquiggles left a comment

Choose a reason for hiding this comment

QueenOfSquiggles commented Jan 8, 2024

QueenOfSquiggles commented Jan 8, 2024

Bromeon left a comment

Choose a reason for hiding this comment

QueenOfSquiggles commented Jan 10, 2024

Bromeon commented Jan 11, 2024

QueenOfSquiggles commented Jan 11, 2024

MarkWilds commented Jan 13, 2024 • edited Loading

QueenOfSquiggles commented Jan 13, 2024

Bromeon left a comment

Choose a reason for hiding this comment

Bromeon Jan 13, 2024

Choose a reason for hiding this comment

QueenOfSquiggles Jan 13, 2024

Choose a reason for hiding this comment

Bromeon Jan 13, 2024

Choose a reason for hiding this comment

Bromeon Jan 13, 2024

Choose a reason for hiding this comment

QueenOfSquiggles Jan 13, 2024

Choose a reason for hiding this comment

Bromeon Jan 13, 2024

Choose a reason for hiding this comment

QueenOfSquiggles Jan 13, 2024

Choose a reason for hiding this comment

QueenOfSquiggles left a comment

Choose a reason for hiding this comment

Bromeon left a comment

Choose a reason for hiding this comment

QueenOfSquiggles left a comment

Choose a reason for hiding this comment

Bromeon commented Jan 14, 2024

Bromeon commented Jan 6, 2024 •

edited

Loading

MarkWilds commented Jan 13, 2024 •

edited

Loading