Unreal Engine Documentation Handbook

Tips and tricks on how to use the Unreal Engine documentation website.

Windows
MacOS
Linux

Page Areas

An Unreal Engine documentation page is split into the following areas:

  1. Top bar: Contains a version switcher, the page's site location (breadcrumbs), and search box. Located across the top of the screen.

  2. Main navigation: Displays links to all the pages on the website in a tree structure. Located on the left-hand side of the screen.

  3. Header: Shows information about the page, such as page title, description, and UE version. Also contains a switch that toggles between Windows, macOS, and Linux-specific content on the page. Located across the top of the screen, under the top bar.

  4. Content area: Contains the information, links, and images for the page's topic.

  5. Sidebar: Summarizes the contents of the page and includes links to other parts of the documentation and/or Unreal Online Learning courses. Located on the right-hand side of the screen.

Top Bar

The top bar contains the following functionality:

  1. Version switcher: Use this to switch between different versions of Unreal Engine documentation.

  2. Breadcrumbs: Contain the full path of the page you're looking at. This matches the page's location in the website's main navigation.

  3. Search box: Search across the entire UE documentation website. Our search uses Microsoft Bing.

  4. Website theme switcher: Click this button to switch between the two available themes on the website: light mode (black text on white background) and dark mode (white text on dark grey background).

Website Navigation

This is a list of all the pages on the website, grouped under high-level goals like understanding the basics of Unreal Engine, creating virtual worlds, or building interactive experiences. You can click and drag to resize this bar.

If you know the title of the page you're looking for, you can use the Filter Pages box at the top of the navigation to quickly find it in the Table of Contents.You don't need to press Enter after you type the text to search. The Table of Contents will refresh automatically.

This video demonstrates how to use the Filter Pages functionality.

The header contains the following information:

  1. Page title and description: The page title and a brief summary of what the page contains.

  2. Unreal Engine version: The version of Unreal Engine for which this page was last updated. Click this tag to see all pages that were updated for this version of Unreal Engine in the Site Map.

  3. Difficulty level: How easy or difficult it may be to understand the concepts or follow the steps on this page. We base this assumption on a number of things, such as what you need to know before attempting the steps on this page and how complex the steps are. Click this tag to see all pages of the same difficulty level in the Site Map.

  4. Operating system (OS) toggle: For pages that have OS-specific content, use this toggle to switch between Windows, macOS, and Linux. For example, a page might contain different steps for how to do a task on Windows and on macOS.

Content Area

This is the main page body. It contains concepts, instructions, images, videos, and so on.

A page may contain Prerequisites. These are concepts and procedures that you should be familiar with in order to better understand the contents on this page.

At the bottom of the content area is a separate footer area that may contain one or more Tags. Click a tag to see all pages with the same tag in the Site Map.

The secondary navigation is located on the right-hand side of the page. It can contain one or more of the following areas:

  1. Table of contents (On This Pageā€¦): A list of the headings on the page. Use it to quickly jump between sections.

  2. Related Links (See Also): A collection of pages whose subject matter relates to the page you're currently on.

  3. Related Courses: A list of Unreal Online Learning courses you can take to learn more about the subject on this page.

Formatting Conventions

Unreal Engine documentation uses bold, italic, underline, and monospace formatting.

Bold text highlights one of the following:

  • Key terms, especially when they first appear on a page.

  • Names and titles of panes, tools, windows, etc. inside the Unreal Engine interface.

Italic text is used for image captions. It may occasionally be used to emphasize specific terms.

Underlined text will always be a link you can click to go to a different page.

Monospace font can represent one of the following:

  • A class, method, or other programming-specific thing. Code blocks also use this font.

  • The name of a file, folder, or file extension.

Epic Games Learning Ecosystem

You can learn even more about how to use Unreal Engine and its many features from the following resources:

  • Unreal Online Learning: A free learning platform that offers hands-on video courses and guided learning paths.

  • MetaHumans documentation: Documentation for Epic's MetaHuman Creator, a cloud-streamed app you can use to create and download high-fidelity digital humans.

  • Epic Online Services (EOS) documentation: Documentation for Epic Online Services, which are free, cross-platform services created to enable fast, easy, and dependable high-quality game launching, operation, and scaling.

  • Fortnite Creative documentation: Documentation for Fortnite Creative, which you can use to design and publish your own Fortnite experiences.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss