Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@malec-palec
Copy link
Contributor

Summary

Adds the ability for extension authors to specify a custom help URL for their actions, conditions, and expressions. When a URL is provided, a help icon (question mark) appears next to the instruction title, allowing users to quickly access external documentation.

Changes

Core (C++)

  • Added helpUrl field to EventsFunction with getter/setter methods
  • Updated serialization to persist helpUrl in project files

GDevelop.js Bindings

  • Exposed getHelpUrl() and setHelpUrl() methods to JavaScript

Metadata Generation

  • Updated MetadataDeclarationHelper to propagate helpUrl to InstructionMetadata and ExpressionMetadata

Editor UI

  • Added "Help page URL" input field in the extension function properties editor
  • Added help icon next to action/condition titles when custom URL is set
  • Added help icon next to expressions in the expression selector
  • Preserved existing "Help for this action/condition" button for wiki-based help

Utils

  • Added isDocumentationAbsoluteUrl() and isRelativePathToDocumentationRoot() helpers to distinguish between custom URLs and wiki paths

Tests

  • C++ unit tests for EventsFunction helpUrl serialization
  • GDevelop.js binding tests for EventsFunction and MetadataDeclarationHelper
  • React tests for HelpLink utility functions
  • Updated Storybook for HelpIcon component

Screenshots

image image image

@malec-palec malec-palec marked this pull request as ready for review December 31, 2025 15:12
@malec-palec malec-palec requested a review from 4ian as a code owner December 31, 2025 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant