Documentation for the Godot source code

DaveTheCoder

I have extensive C++ experience, although it's been a while since I've used it.

I've tried to locate stuff in the source code, but have trouble navigating though the classes, and there are hardly any inline comments.

Is there any developer documentation that can help with this?

Megalomaniak

Going through the git commit history might be a way to gain some insight, though I know it's not what you are asking for exactly. But also don't forget that there is a developers irc channel enabling you to talk with and ask questions from other engine developers.

TwistedTwigleg

I don't think there is any documentation for the source code itself, besides the comment here and there that generally is just for a specific section of code. I found that most of the nodes are similar to nodes you might make in GDScript or C#, but some of the other code, like Resources, are kinda confusing depending on how they are implemented. Some files are also rather large, which can make them overwhelming to go through. Most of the large files though, from my limited experience, are generally just lots of small components all together in large chunks (like 1/3 is thing A, another 1/3 for thing B, and the last 1/3 for thing C).

I think that Megalomaniak's suggestion of talking to the developers on the IRC is probably the best route. That's what I did when I was poking around in the source code and the developers there helped and pointed me in the right direction :smile:

Edit: Also, I would recommend reading the best practices for engine development on the Godot documentation if you have not already, as it explains how PRs and code are generally evaluated.

DaveTheCoder

Calinou: Do you have any advice for my question here? https://godotforums.org/discussion/25343/documentation-for-the-godot-source-code

Calinou

@DaveTheCoder said: Calinou: Do you have any advice for my question here? https://godotforums.org/discussion/25343/documentation-for-the-godot-source-code

I recommend joining the Godot contributors chat listed on https://godotengine.org/community and asking questions as you go :)

dotted

@DaveTheCoder

Are you using an IDE (Eclipse/CodeLion/ETC)? A proper IDE is a life saver. I make heavy use of 'find-definition(s)` find-declarations and find-usage editor options all the navigate the godot code base.

I am using CodeLion mostly because it's a commercial variant of an Eclipse like environment

DaveTheCoder

I've been using grep, but an IDE is a good idea.

dotted

I call it essential. For a project that large, absolutely

DaveTheCoder

You're right. Can you recommend an open source C++ IDE for Linux (Pop!_OS)?

I have IntelliJ IDEA, but apparently JetBrains discontinued its C++ support so that it wouldn't compete with their commercial product CodeLion.

I'm experimented with Eclipse, but haven't used it seriously.

dotted

Well, I used eclipse for years (java, php and javascript) and it has plenty of C++ options. The primary reason I used CodeLion over it, is JetBrains has slightly better "polish" in some areas.

But doing a quick search, it appears Eclipse can use SCONS directly in its projects. In this regard it may even be better. I would recommend downloading of the standard C++ distro and adding any SCONS support as needed.

Eclipse has a in-IDE plugin and update mechanism so use to search for and install SCONS support as needed. Toss in git for your revision control while you are at it.

Play with a "test" project of your own code to get feel for writing/debugging and also try importing godot as an existing project separately. If that all works you should have some exceedingly helpful navigation tools from class structure, to finding definitions/declarations and usages.

At least at that point you can make an assessment of whether you want to keep using it. There may be other IDEs out there but I'm OK with what I have ATM.

Megalomaniak

I always liked NetBeans, but I guess YMMV.

dotted

Way back when, I tried NetBeans and it was so god awful slow that it put me off of it. Granted that was like 1997 or something.

Megalomaniak

I used it in around 2010 and it seemed as fast and far more stable than eclipse, but as I said, YMMV I suppose.

DaveTheCoder

It wasn't my intent to hijack this topic. Is it possible to move the replies, starting with my question to Calinou, to the other topic linked there?

For Godot, do you guys use an IDE for building, or only for viewing/editing? I was going through the documentation, and see that building is done by a make-like command line tool, Scons.

Megalomaniak

You can set it up for convenience so it does the build from the IDE as well or you can use the SConststruct system on it's own. Up to you. Easier to start with Scons on it's own perhaps and only set it up via IDE once you've become more familiar with whatever IDE you've come to prefer IMO.

dotted

@Megalomaniak I hadn't known that Eclipse had scons project or build integration, which piques my interest. Having the build env work directly can be immensely helpful, because that is how the IDE often knows that source code to care about.

Megalomaniak

I think it's rather SCons that can generate the project files? But then SCons is basically a replacement for make. It's been a while since I've dealt with this though, mostly using GDScript and the integrated editor these days.

From a quick google search this came up for eclipse tho: https://cute-test.com/guides/scons/

May be of interest perhaps.