`/info` endpoint via editor api

Open
#13,757 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
52/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
clojure
Domain
api

Research direction

Start by locating the editor API routes and the existing /eval handler, then compare them with the engine’s /info endpoint mentioned in the issue. Define which editor and running-game details the API can provide, and add an endpoint that exposes them; done means external editors can query this information without a game running.

Written by the indexing model from the issue text.

Description

AI/LLM workflow editor feature request

Is your feature request related to a problem? Please describe (REQUIRED):

I'd like to be able to query certain editor information (e.g. the engine version) for the use in external editors. This could be used for various things like querying the correct Lua annotations and enabling/disabling certain features like for instance the new debugger functionality, or well notifying the user that they're using an unsupported version of Defold (as far as I'm concerned) instead of showing them an error because something doesn't work (as I might expect a newer version or something)

The engine seems to have an /info endpoint that kinda already does this, but this can't be queried unless a game is running

Describe the solution you'd like (REQUIRED):

The editor api should provide an /info endpoint providing useful information like the editor version, projects root directory (game.project), the project instance index, infos about whetever or not a game is running (and its pid / engine port etc). At least these are infos that would be very useful to me :).

Describe alternatives you've considered (REQUIRED):

This is technically currently possible via /eval and this is also what I'm using

Dominant language
C++
Stars
6.5k
Forks
470
Avg merge
2d 11h
Merged PRs (30d)
172

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from defold/defold

All issues in defold/defold

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.