Skip to content

A simple electron-based app used for browsing the UE5 documentation which you can pin on top of all windows

License

Notifications You must be signed in to change notification settings

puchik/UE5-Documentation-Browser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

UE5 Documentation Browser

A simple electron-based app used for browsing the UE5 documentation which you can pin on top of all windows.

While navigating the painful experience of getting an IDE that works well with unreal engine, I found a neat UnrealVsCodeHelper extension that had a built in browser for the documentation. I'm still not entirely convinced on using VS Code for UE (yet?), but I did really enjoy this idea and would have liked it to have it in Visual Studio.

I decided to quickly build an electron app that is basically a cut-down glorified web browser that lets you browse the UE docs.

Opening a separate browser window can get kind of painful if you want the docs on hand. Open it, search for the docs or use a bookmark, have a bunch of other tabs or windows open, go back manually when you're done looking for something, need to keep switching windows...

Conversely, this one opens directly to the documentation search (optionally to the Blueprint or C++ API), removes various headers and footers or things that could otherwise clutter the page, and lets you search directly. You can also pin it on top of all windows and scale it however you like.

Is it janky? Kind of! Does it have hardcoded strings and element IDs? Yes! Does it work? Also yes!

Known issues

  • You tell me.

About

A simple electron-based app used for browsing the UE5 documentation which you can pin on top of all windows

Resources

License

Stars

Watchers

Forks

Packages

No packages published