[TRACKER] Porting the demos to Godot 4

[aaronfranke]

This issue tracks the progress of porting the Godot demo projects to Godot 4.0. This list is in alphabetical order by folder path.

• ✅ and a checked box means that the demo is fully ported and working.

• 🚧 means that the demo still needs to be ported manually.

• 🐛 means that there are engine (not project) bugs that show up in this project. Projects that have bugs but the cause is unknown don't get 🐛.

• 🐞 means that there are minor bugs such as errors printing in the console.

• 🌋 means that there is a bug with rendering (possibly a problem with the project).

• 📜 means that there is a bug with scripting (can be GDScript/C#/VisualScript).

• 🖽 means that this project uses TileMap. 3.x tile data doesn't work in master.

• 💥 means that opening the editor with this project causes the engine to crash.

• [x] ✅ Bullet Shower

• [x] ✅ Dodge the Creeps

• [x] ✅ Hierarchical Finite State Machine

• [x] ✅ GD Paint

• [x] ✅ HDR for 2D (renamed to Glow in 2D due to https://github.com/godotengine/godot/issues/54122)

• [x] ✅ Hexagonal Game

• [x] ✅ Scene Instancing Demo

• [x] ✅ Isometric Game

• [x] ✅ Kinematic Character 2D

• [x] ✅ 2D Lights as Mask

• [x] ✅ 2D Lights and Shadows

• [x] ✅ Navigation Polygon 2D https://github.com/godotengine/godot-demo-projects/pull/955

• [x] ✅ Grid-based Pathfinding with Astar

• [x] ✅ 2D Particles

• [x] ✅ Physics-Based Platformer 2D

• [x] ✅ 2D Physics Tests https://github.com/godotengine/godot-demo-projects/pull/962

• [x] ✅ Platformer 2D

• [x] ✅ Pong with GDScript

• [x] ✅ JRPG Demo https://github.com/godotengine/godot-demo-projects/pull/922

• [x] ✅ Screen Space Shaders

• [x] ✅ Skeleton2D Demo

• [x] ✅ 2D Shaders for Sprites

• [x] ✅ Tween Demo

• [x] ✅ 3D Global Illumination

• [ ] 📜 3D Inverse Kinematics

• [x] ✅ Kinematic Character 3D

• [x] ✅ Material Testers

• [x] ✅ 3D Navigation Mesh

• [x] ✅ 3D Physics Tests

• [x] ✅ Platformer 3D

• [x] ✅ RigidBody Character 3D

• [x] ✅ Truck Town

• [x] ✅ Volumetric Fog

• [x] ✅ Voxel Game https://github.com/godotengine/godot-demo-projects/pull/965

• [x] ✅ 3D Waypoints

• [x] ✅ BPM Sync Demo

• [x] ✅ Audio Device Changer Demo

• [x] ✅ Audio Generator Demo

• [x] ✅ Audio Mic Record Demo

• [x] ✅ Audio MIDI Piano Demo

• [x] ✅ Audio Spectrum Demo

• [x] ✅ BIDI and Font Features

• [x] ✅ Control Gallery

• [x] ✅ Drag and Drop (GUI)

• [x] ✅ Input Mapping GUI https://github.com/godotengine/godot-demo-projects/pull/1024

• [x] ✅ Multiple Resolutions

• [x] ✅ Pseudolocalization Demo (should use canvas_items stretch mode)

• [x] ✅ RegEx (Regular Expressions)

• [x] ✅ Rich Text Label with BBCode

• [x] ✅ Signed Distance Field Font (renamed to Multi-channel Signed Distance Field font) https://github.com/godotengine/godot-demo-projects/pull/1024

• [x] ✅ GUI Theming Override Demo

• [x] ✅ Translation Demo https://github.com/godotengine/godot-demo-projects/pull/930 https://github.com/godotengine/godot-demo-projects/pull/1024

• [ ] 🚧 UI Mirroring Demo https://github.com/godotengine/godot-demo-projects/pull/974

• [x] ✅ Autoload (Singletons)

• [x] ✅ Background Thread Loading Demo

• [x] ✅ Multiple threads loading

• [x] ✅ Scene Changer

• [x] ✅ Saving and Loading (Serialization)

• [x] ✅ Loading in a Thread

• [x] ✅ 2.5D Demo with GDScript

• [x] ✅ Joypads Demo

• [x] ✅ Matrix Transform https://github.com/godotengine/godot-demo-projects/pull/978

• [x] ✅ OpenSimplexNoise Viewer (renamed to Noise Viewer as 4.0 uses FastNoiseLite)

• [x] ✅ Operating System Testing

• [x] ✅ Pause Demo https://github.com/godotengine/godot-demo-projects/pull/1024

• [x] ✅ Window Management

• [x] ✅ Android In-App Purchases https://github.com/godotengine/godot-demo-projects/pull/1024

• [x] ✅ Interactive Cubes

• [x] ✅ Multitouch View

• [x] ✅ Accelerometer, Magnetometer and Gyro Demo

• [ ] 🚧 2.5D Demo with C#

• [x] ✅ Android in-app purchases with C# https://github.com/godotengine/godot-demo-projects/pull/1104

• [ ] 🚧 Dodge the Creeps with C# https://github.com/godotengine/godot-demo-projects/pull/1000

• [ ] 🚧 Pong Multiplayer with C#

• [x] ✅ Pong with C# https://github.com/godotengine/godot-demo-projects/pull/966

• [x] ✅ Multiplayer Bomber https://github.com/godotengine/godot-demo-projects/pull/987

• [x] ✅ Pong Multiplayer

• [ ] 🚧 WebRTC Minimal Connection

• [ ] 🚧 WebRTC Signaling Example

• [x] ✅ WebSocket Chat Demo

• [x] ✅ WebSocket Minimal Demo

• [x] ✅ WebSocket Multiplayer Demo

• [x] ✅ Plugin Demos https://github.com/godotengine/godot-demo-projects/pull/1024

• [x] ✅ 2D in 3D Demo

• [x] ✅ 3D in 2D Demo

• [x] ✅ 3D Viewport Scaling https://github.com/godotengine/godot-demo-projects/pull/891

• [x] ✅ Dynamic Split Screen

• [x] ✅ GUI in 3D Demo

• [x] ✅ Screen Capture

[GeorgeS2019]

@Anutrix

I would suggest start with what u are comfortable , which render environment and share openly what u are not comfortable so others with the right competency which can complement u to work on the missing part.

The key is communication

Start the communication so others know how to support u moving forwards.

[Calinou]

Do I need to it to be running in all 3 rendering drivers. Is running with few warnings are fine?. Should I test with .NET version of Godot too?, etc. I still don't know the answer to some of these questions.

You only need to test the rendering method the project currently uses on desktop. You don't need to test with a .NET version of Godot unless the project uses C#.

Do we have any guidelines, FAQs or similar page for 'Contributing to Godot Demo Projects'?

Not yet, but I intend to write guidelines in a few weeks from now. Edit: Done in https://github.com/godotengine/godot-demo-projects/pull/912.

[InfiniteProductions]

I'm also willing to help, I just need a way to know who test what with what results with a good enough update frequency, even if it's means we update it ourselves, to go on the right path.

[hsandt]

For 2D Lights as Mask, I found that setting Burano TextureRect > CanvasItemMaterial > Light Mode from Light Only to Normal makes the photo appears as it should, with the textured lights:

In fact, removing the material altogether to use standard one also works.

[hsandt]

So I tested the demo in Godot 3 to compare, and Light Only works, and the result is different:

and that's the intended result. So switching to Normal is just hiding the problem.

In the meantime I thought the core issue for Light Only failing: https://github.com/godotengine/godot/issues/44559

[Calinou]

Several demos in 3.x were revamped with new art assets:

• https://github.com/godotengine/godot-demo-projects/pull/898
• https://github.com/godotengine/godot-demo-projects/pull/904
• https://github.com/godotengine/godot-demo-projects/pull/905
• https://github.com/godotengine/godot-demo-projects/pull/915

Remember to use the commits linked at the end of each PR as a base, as they include some additional changes that aren't in the PRs themselves.

These demos should be ported to master again, since a lot of things have changed within them. It'll be faster to discard the master copy and start converting the current 3.x demo from scratch.

[Calinou]

Just a heads up to note that I've started working on porting the demos linked in https://github.com/godotengine/godot-demo-projects/issues/697#issuecomment-1541083705.

Edit: Pull request opened, but I need help porting the 2D JRPG demo: https://github.com/godotengine/godot-demo-projects/pull/922

[GeorgeS2019]

WIP Track Demo for 4.1

Today is an important 4.1 milestone. Wonder if there are ways to track demo reflecting new features or changes in 4.1

• [ ] Rendering

  • [ ] NoiseTexture3D

• [ ] Navigation

  • [ ] Support different actor types

[TheYellowArchitect]

Hello! I see that once I download 4.1 from the official website, there are 2 great links below the donations button. The first redirects to the docs, the 2nd to the asset library demos. All demos seem 3.5. Until most demos are updated, I suggest hiding the 2nd button.

[TheYellowArchitect]

Loading Tutorials

I tested them all, and all are functional, yet they have the 3.5 tag instead of the 4.0?

Networking Tutorials

• pong tutorial is broken
• WebRTC Minimal connection is broken

I tried placing the GDExtension as recommended in the tutorial, got a worse error on opening it lol

• WebRTC Signalling example, same error as above pretty much. Cannot load GDExtension.
• All WebSocket tutorials are broken because they are from 3.5 or sth. No idea what to even put as address...

  var _server = WebSocketServer.new() -> @onready var _server = WebSocketMultiplayerPeer.new().create_server(PORT, ???)

[TheYellowArchitect]

Viewport Tutorials

• 2D in 3D -> perfect as is, I doubt it even asked for conversion from 4.0 to 4.1
• 3D in 2D -> works as expected
• 3D Subviewport Scaling -> Not sure. Maybe it should zoom? I have to open in 3.5 to confirm. Aside of that, 3D inside Control/Viewport works great.
• Dynamic Split Screen -> Damn, this is great. I am glad I checked each demo if it works, otherwise I would have missed it. Works as expected ofc, and is polished.
• GUI in 3D -> It has this error and the GUI also looks very pixely, something is wrong.
• Screenshot Capture -> Works great. It even tricked me thinking it's recursive, cool visual trick.

[TheYellowArchitect]

Audio Tutorials

All work great, except the text-to-speech. I cannot test it at all because I guess it uses default OS voicecharacters or whatever they are called and I have none. I would also suggest typed variables and better variable names there.

Also I cannot verify if the BPM_sync works as expected, looks good to me, but I am not that familiar with BPM stuff to confirm the BPM is the same as printed on the UI label.

Off-topic

All other audio tutorials work as expected, some surprised me tbh. If I had seen them on a new godotengine post on a new audio feature I would be hyped, yet it's already a thing... Some examples: - MIDI Piano can be stretched in a week to allow the player character to play piano for fun (cool easter egg which would take months on a custom game engine, and that's why no games do it, e.g. background piano being playable) - Spectrum for custom UI stuff (scifi games) - Text-To-Speech for voice-acting many characters (though there are AI tools nowadays to get easy high quality voiceacting) - generator and device_changer are neat for changing the soundscape for easter eggs. - mic recorder, cant see it usable in singleplayer games, but still great feature.

[TheYellowArchitect]

GUI Tutorials

• GDPaint works as expected. Creative usage is viable here.
• Drag_and_drop works as expected. Frequent usage for so many games!
• Control Gallery is poggers, but there is a bug: The Menu Button (below OptionButton) is bugged, since nothing selected actually applies. I wish I had found this tutorial far earlier, it must have been skipped by so many like me, but it basically explains fundamental UI intuitively.
• bidi_and_font_features. Literally untestable by me, and I hope not others. All buttons are grayed out (right to left and vice versa) and I can't tell if that's a bug or I miss fonts of that non-european language. A tutorial is meant to explain by intuition, but if the buttons being grayed out/disabled is not a bug, then this demo needs some further development.
• input_remap works as expected. Though I would suggest an enhancement, to have a ball or capsule player, and have him move. Because the input remapping is displayed on the user when he stops the project and starts it again, and the old input maps persist to the new buttons as strings. But strings alone aren't as intuitive as a literal object moving the same way but with different buttons, binded realtime.
• msdf_font works as expected. I didn't expect such difference from traditional to msdf, pixely to .svg smooooth.
• multiple_resolutions works as expected. Kinda wild to see this, as it dwarfs "make your own resolutions options" youtube tutorials.
• pseudolocalization is weird. The below happens on toggling ON pseudolocalization (which becomes ON by default) Assuming that error doesn't exist, I still cannot test it because I don't understand it at all. That language does not exist, so I don't know how the intended behaviour should be. Anyway, at least me and most other devs are not the target audience for this demo's features, so it's not a big deal if this doesn't work perfectly. Also, I typed some Greek characters in there, but it didn't work like the english characters (so on pseudolocalize button, it remained as is, except for 1 filter choice which really jumbles it all), so I suggest allowing exclusively english characters in the top box.
• Regex works as expected. Though on the hyperlink of RegExr, I suggest adding also regex101.com, as I personally find it better.
• RichTextBBCode is bugged. Tooltip breaks font resolution or sth, I cannot tell what is the cause of the bug, only what it does visually. I even screen-recorded the bug for convenience of whoever reads this: https://files.catbox.moe/z9wkva.mkv Also, the table items split in 2 columns should be more to the left, as in, properly aligned to their left line.
• ThemeOverride works as expected. Though its kinda barebones. Sure, a user can experiment atop of it, but to change the texture of a button or panel contents, and change the edges/margin of a panel is what would make this a beefy tutorial.
• Translation has a bug on opening, as shown on the image below (no main scene, and font missing?) Yet, if I press F5, it runs normally and works as expected. So it's nothing serious I assume.
• UI Mirroring demo, unlike other tutorials which are 4.0 (only Loading tutorials were 3.5 thus far), is from 3.3 and requests conversion. I converted full project automatically, and there were 2 debugger console errors (probably nothing) but I reloaded project just in case, and no errors. But while there are no logic errors, I don't see anything reacting, so it is safe to say it is heavily bugged and needs manual conversion.

[Calinou]

I went through all demos with 4.2.dev4 and ticked off which ones work correctly and which ones remain to be ported.

• Control Gallery is poggers, but there is a bug: The Menu Button (below OptionButton) is bugged, since nothing selected actually applies. I wish I had found this tutorial far earlier, it must have been skipped by so many like me, but it basically explains fundamental UI intuitively.

MenuButton functionality for persisting checkbox/radio button changes was never implemented (it needs scripting in the project). Feel free to open a pull request for this :slightly_smiling_face:

• RichTextBBCode is bugged. Tooltip breaks font resolution or sth, I cannot tell what is the cause of the bug, only what it does visually.

This is an engine bug: https://github.com/godotengine/godot/issues/54030

Also, the table items split in 2 columns should be more to the left, as in, properly aligned to their left line.

I couldn't figure out how to do that, unfortunately.

UI Mirroring demo, unlike other tutorials which are 4.0 (only Loading tutorials were 3.5 thus far), is from 3.3 and requests conversion. I converted full project automatically, and there were 2 debugger console errors (probably nothing) but I reloaded project just in case, and no errors. But while there are no logic errors, I don't see anything reacting, so it is safe to say it is heavily bugged and needs manual conversion.

I've tested the demo in 4.2.dev4 and nothing happens when I press various buttons. This will need a second look by @bruvzg who initially made this demo.

[Alex2782]

Accelerometer, Magnetometer and Gyro Demo has the status the demo still needs to be ported manually.

is it this example? https://github.com/godotengine/godot-demo-projects/tree/master/mobile/sensors

2 weeks ago I tried on my android tablet and found no problems, what changes exactly are still needed there?

[Alex2782]

@Calinou: Has anyone ported TileMap to version 4 yet?

I have ported some scripts. But how Grid.gd (extends TileMap) would have to be ported, I unfortunately do not know yet. (some lines commented out)

Should I still create PR? So that others can continue. I would have to get better acquainted with TileMap first.

https://github.com/godotengine/godot-demo-projects/compare/master...Alex2782:godot-demo-projects:role_playing_game_v4.1

Current state:

[Alex2782]

(3D) kinematic_character

The description would still have to be adapted here. The 2 classes no longer exist. The name 'Kinematic Character 3D' would have to be renamed to 'Character Body 3D'?

This demo uses a KinematicBody for the player, and StaticBody for the level.

... the player extends CharacterBody3D and the level ?

[Alex2782]

Pong Multiplayer no problems detected

v4.1.2.stable.official [399c9dc39]

[AliceGrey]

@aaronfranke 2.5D Demo with GDScript is not fully converted to 4. The node25d plugin is broken and does not currently run on 4.

[Alex2782]

@aaronfranke 2.5D Demo with GDScript is not fully converted to 4. The node25d plugin is broken and does not currently run on 4.

I could not find any problems. Master Branch was updated 5 months ago, version 4.0. I tested with Godot Version 4.2 Beta4

https://github.com/godotengine/godot-demo-projects/tree/master/misc/2.5d

[MatrixFrog]

@Alex2782 I don't understand TileMap extremely well yet either but I think I'm making progress on that 2D RPG demo, using the branch you posted above as a starting point: https://github.com/godotengine/godot-demo-projects/pull/1009

Will try to get it fully working in the next few days...

[GeorgeS2019]

We could consider demonstrating the C# examples using Godot 4 (Scene) Test-Driven-Development (TDD) in e.g. VS2022

Note

In this example, I simply run a Godot4 scene: example audio/spectrum with attached GDScript The idea is that once the GDScript is running, using Test-Driven-Development to port the GDScript to C# under the same working environment and conditions as those of the working GDScript

https://youtu.be/JLI0cIYMgr0

using the latest gdUnit4API TestAdaptor from @MikeSchulze

https://github.com/godotengine/godot-proposals/assets/49812372/72bb91a1-dd1c-4467-8d07-3b0d3beadd4b

[tinybitofheaven]

I wanted to ask if I could work on Multiplayer Pong with C#? I've already started looking into converting it, it seems that multiplayer in Godot 4 is radically different from Godot 3 and a lot of RPC syntax is hard to find a direction conversions in C#. I'll keep working on it since I don't think anyone else is right now, but let me know if I'm wrong about that.

Also wanted to mention that one of the links in the tracker post is linked incorrectly.

[Calinou]

I wanted to ask if I could work on Multiplayer Pong with C#? I've already started looking into converting it, it seems that multiplayer in Godot 4 is radically different from Godot 3 and a lot of RPC syntax is hard to find a direction conversions in C#. I'll keep working on it since I don't think anyone else is right now, but let me know if I'm wrong about that.

Yes, feel free to open a PR to update it :slightly_smiling_face:

The non-multiplayer Pong with C# demo was updated in https://github.com/godotengine/godot-demo-projects/pull/966.

Also wanted to mention that one of the links in the tracker post is linked incorrectly.

Fixed.

[tinybitofheaven]

I believe I've gotten Multiplayer Pong C# working in Godot 4.2 in [#1045]. However, I wanted to follow up on something. It seems that there isn't much documentation on implementing Multiplayer with C# in Godot 4, at least I couldn't find it very easily. In the high-level multiplayer documentation, there's only GDScript. Is there plans to add more C# multiplayer documentation in the future? Or does the documentation exist and I just missed it?

[Calinou]

Is there plans to add more C# multiplayer documentation in the future? Or does the documentation exist and I just missed it?

We welcome pull requests on https://github.com/godotengine/godot-docs to add C# code samples to pages that only have GDScript code samples. That said, we don't have plans to add dedicated pages for C# networking. The base concepts are already independent of the scripting language – only the code blocks really need to be adapted for C#.