Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Unreal Console documentation #299

Merged
merged 3 commits into from
May 24, 2024
Merged

Add Unreal Console documentation #299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c0f0c7
Add Unreal Console documentation
SpaceGameDev568 May 23, 2024
b500d06
Fix typo in the command name
SpaceGameDev568 May 23, 2024
46fbc9f
Remove redundant explanation about using launch args
SpaceGameDev568 May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added modules/ROOT/images/TestingResources/Unreal-Console.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions modules/ROOT/pages/Development/TestingResources.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,21 @@ will affect every instance of Command Prompt on your system.
See the link:#_launch_script_enhancements[Launch Script Enhancements] section below
for another method of controlling where the window will appear.

== Unreal Console

The Unreal Console is a useful tool for debugging your mods.
It allows you to view the game's log in real-time, and input console commands.
In order to open the console, you will need to add this to your game's command-line options:

`-Log -NewConsole`

If you don't know how to do that, you can refer to xref:faq.adoc#_how_do_i_start_the_game_with_launch_arguments[this guide].

Now, when you launch the game, you should see the Unreal Console appear as a separate window.
Here, you can view the game logs, enter commands, and see the game's current status.

image:TestingResources/Unreal-Console.png[image]

[id="LaunchScript"]
== Quick Launch Script

Expand Down