Discover Unreal Engine APIs Offline with Zeal | Blurred code

Discover Unreal Engine APIs Offline with Zeal

2023/03/11

LastMod:2023/03/11

Categories: UE

For days I have been using an offline documentation browser named zealdocs/zeal to search for and browse the APIs I need while programming. Zeal is an open-source offline documentation, which is compatible with the popular MacOS-Only paied documentation tool named Dash.

Zeal offers several open-box documentations, including CPP and Lua documentation. Unfortunately, there is no official UE documentation availbale from Epic Games or Zeal. Some developpers have taken it upon themselves to grab contents from Unreal Engine website and create their own documentation.

The details about methods and scripts to make a documentation are described in this blog. If you're interested in creating the latest documentation, you may need a Python2 environment and scrape from Epic on your own.

Reference:抓取 UE API 并生成带索引的 Dash 文档 | 循迹研究室

There are also some user-contributed docsets availlable online. Here are the URLs I've collected so far:

To use offline docsets, simply download them and extact them to the directory specified under Prefereces->General->Docset Storage.