godotengine / godotengine/godot-docs

Improved headless documentation (including build instructions)

Open
#2,672 2 comments 1 reaction 0 assignees View on GitHub
area:manual content:new page enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

Not exactly sure where this should go so feel free to correct me if I missed here.

I would love to see more official documentation on how to use the headless version of Godot, primarily because I feel like it is the ideal way to export projects (in a CI/CD system). Currently there are only two hits for headless in the official docs, and they are just brief mentions. Topics that would be great to cover:

* Exporting projects with headless (CLI options, examples, etc.)
* Common exporting "gotchas" (main example I can think of here is that when exporting with headless for mac from windows/linux, if you use a .zip extension via CLI you only get the pck file, whereas through the editor if you use a .zip extension you get the full app bundle zip)
* Build instructions

I'm not sure if that last one actually requires work on the build system or not, but I have not yet found or figured out how to build headless on my own, and would love to be able to do that. Especially since for my workflow I keep scripts around for building the engine/editor, and including headless in that since I use it too would be great.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.