Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/.vitepress/config/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,10 @@ const sidebar: Sidebar = {
text: 'Installing',
link: 'installing',
},
{
text: 'Dummy Classes',
link: 'dummy_classes',
},
// {
// text: 'Dummy Classes',
// link: 'dummy_classes',
// },
{
text: 'Project setup',
link: 'project_setup',
Expand Down
4 changes: 3 additions & 1 deletion docs/essential/02_clarifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ One frequently asked question is “why do we have to use UDK?” Rocket League

**Maps made with UDK 2015 cannot be opened in UDK 2013,** but the reverse is not a problem at all. If everyone makes the switch to UDK 2015, then we will have world peace.

## Unreal Engine 4
## Unreal Engine 4/5

UDK is for Unreal Engine 3. Unreal Engine 4 was first released in 2014, and it’s almost a completely new engine. **Unreal Engine 4 cannot be used for Rocket League Mapmaking.**

There were some rumors about the game Rocket League moving to Unreal Engine 5, but this was not confirmed by Psyonix. [Read more](/more/ue5) about what this could mean for making custom maps.

## File Extensions

![Windows settings menu for file explorer](/images/udk/essential/clarification_extensions.png "Don't not not hide")
Expand Down
32 changes: 13 additions & 19 deletions docs/essential/03_installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,16 @@ title: Installing
* A full-featured 3D modeling program like [Blender](https://www.blender.org)
* A capable image editor like [Paint.net](http://www.getpaint.net/download.html#download) or [GIMP](https://www.gimp.org/downloads/) to accompany Blender. If you have Photoshop or something else you prefer, stick with that.

## All-in-One Packages
## All-in-One Packages <Badge text="recommended" type="tip"/>

If you don’t want to stress about this setup process, there are two publicly-available packages which streamline it immensely.
If you don’t want to stress about this setup process, there are some publicly-available packages which streamline it immensely.

### RocketLeagueMapmaking UDK RL Setup Script <Badge text="recommended" type="tip"/>

This script is meant to hold your hand through the entire setup process, take care of tedious and error-prone steps for you, then generate a Project folder that starts you off on the right path. Refer to the section below to install UDK properly.
[This script](https://github.com/RocketLeagueMapmaking/UDK_RL_Setup) is meant to hold your hand through the entire setup process, take care of tedious and error-prone steps for you, then generate a Project folder that starts you off on the right path. Refer to the section below to install UDK properly.

* [GitHub Link](https://github.com/RocketLeagueMapmaking/UDK_RL_Setup)
* [Discord support channel](https://discord.com/channels/711882968200904715/712403230516052038)

### Newk’s UDK Simple Setup

To download this, you will need to make an account with RocketLeagueMods.com, our little corner of the VideoGameMods network. Newk’s package supplies detailed instructions for installing UDK 2015, and provides a huge set of resources to get going quickly. Refer to the section below to install UDK properly.

* [RocketLeagueMods Link](https://rocketleaguemods.com/mods/udk-2015-simple-setup/)

:::warning Setup steps
The steps for the setup using this tool may differ from this guide and the other tools, see the page on the rocketleaguemods website for more information. Note that it might be outdated and it might not have all the latest discoveries added
:::
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/CfelMbPLF6U?si=45jt7nXF4s2ohOn3" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

## Running the Installer

Expand All @@ -41,14 +32,17 @@ After you [download the UDK 2015 Installer](../resources/downloads.md#setup) fro

In the Project Name field, enter a good name for your project. I call mine RLMM (Rocket League MapMaking) but yours will be referred to as `{ProjectName}` in this guide. Additionally, this folder will be called `{UDK Folder}` for the rest of this guide.

> [!DANGER]
> You cannot choose a project name with a space or other special characters!
> This could give you trouble later, such as when running installers.

Twiddle your thumbs for a few minutes as it installs prerequisites and then installs UDK.

Ignore the extra options, and complete the install.

## Things to Change

If you used one of the All-in-One packages, you may skip ahead to [and start a UDK project](project_setup.md#starting-a-new-project). If you are manually setting up UDK, or just want to see what is happening behind the scenes with those packages, please continue.

:::danger Manual Installation
If you are going to install UDK manually: don’t launch it, because we have some things to change.
If you are manually setting up UDK, or just want to see what is happening behind the scenes with those packages, please continue. Don’t launch it, because we have some things to change.

Before continuing, [read more](./04_dummy_classes.md) about the files that need to be changed.
This list is not updated recently and the Dummy classes repository can have more changes in Core and Engine classes!
:::
58 changes: 43 additions & 15 deletions docs/essential/05_project_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,53 @@ title: Project Setup

UDK is from a different era of software project development, so it doesn’t have a lot of the nice features (or the look) that we have grown accustomed to. It can be a bit annoying to navigate and understand, so the next few sections will be a walkthrough of how you should set it up.

:::info Guide paths

To customize your guide experience, you can change the paths to your installation. These settings are saved locally in the browser only.

<PreferenceSetting
storeKey="rlmm-path-udk"
defaultValue="C:\UDK\RLMM\"
type="input"
:resetOptions="{ enabled: true }"
>

UDK Installation folder
</PreferenceSetting>

Use the location of [the UDK installer](./installing#running-the-installer) for this path. This path can be referred as `{UDK Folder}` throughout the guide.

<PreferenceSetting
storeKey="rlmm-path-rl"
defaultValue="C:\Games\SteamApps\common\rocketleague\"
type="input"
:resetOptions="{ enabled: true }"
>

Rocket League installation folder
</PreferenceSetting>

You should see in <code><PreferenceSetting storeKey="rlmm-path-rl" defaultValue="C:\Games\SteamApps\common\rocketleague\" type="input" :renderValue="true" />TAGame\CookedPCConsole</code> a list of `.upk` game files. This path can be referred as `{CookedPCConsole}` throughout the guide.

You can change more preferences [in the settings page](/settings).

:::

## Folder Setup

> [!TIP]
> If you used the installer package, these shortcuts are already created for you.

I use Windows 10 and the Steam version of Rocket League, so please keep that in mind through the entirety of this guide. Because Rocket League is no longer officially supported on Mac or Linux as of 2019, and installing UDK is also unlikely to work, you're almost certainly going to have to be on Windows also.

* My Rocket League install location is `C:\Games\SteamApps\common\rocketleague`
* My Rocket League install location is <code><PreferenceSetting storeKey="rlmm-path-rl" defaultValue="C:\Games\SteamApps\common\rocketleague\" type="input" :renderValue="true" /></code>
* All Rocket League assets live inside `\TAGame\CookedPCConsole`
* Several of my modded maps live inside `\mods`, a folder I created
`C:\Games\SteamApps\common\rocketleague\TAGame\CookedPCConsole` will be referred to as `{CookedPCConsole}` for simplicity.

* As mentioned in the [UDK install process](installing.md), everything will live inside `{UDK Folder}`
* **Each individual custom map should live inside a folder within `{UDK Folder}\UDKGame\Content\Maps\`**
* **Each individual custom map should live inside a folder within <code><PreferenceSetting storeKey="rlmm-path-udk" defaultValue="C:\UDK\RLMM\" type="input" :renderValue="true" />UDKGame\Content\Maps\ </code>**
* In addition to these folders, I highly highly recommend making two Windows File Explorer shortcuts, or bookmarking these locations
* One that points to `{CookedPCConsole}`
* One that points to `{CookedPCConsole}`: <code><PreferenceSetting storeKey="rlmm-path-rl" defaultValue="C:\Games\SteamApps\common\rocketleague\" type="input" :renderValue="true" />TAGame\CookedPCConsole</code>
* One that points to the Steam Workshop folder for Rocket League. This may be found in the Steam install location (the first half of `{CookedPCConsole}`), but instead of `\common\` it will be `\workshop\content\252950\`. Each downloaded map has a custom identifier in here, and it can be incredibly valuable to open them up in UDK and see how things are made.
* Keep these within the `\Maps\` folder

Expand All @@ -31,7 +65,7 @@ I use Windows 10 and the Steam version of Rocket League, so please keep that in
I highly recommend creating folder shortcuts between all of these places, because it’s easy to get lost. It also gets tiresome navigating folders all day.
:::

## Batch Script For Quickly Testing Maps (BSFQTM) <Badge text="important" type="tip"/>
## Batch Script For Quickly Testing Maps (BSFQTM) <Badge text="important" type="tip"/> {#bsfqtm}

Create a new text file, then rename it something like UtopiaOverwrite.bat. To use this script, simply drag your map file onto it, and it will overwrite the Rocket Labs Utopia Retro (donut) map, which is not used in any online multiplayer playlist.

Expand All @@ -46,15 +80,7 @@ echo F|xcopy /y "%~1" "{CookedPCConsole}\Labs_Utopia_P.upk"
```

CookedPCConsole is the folder containing all of Rocket League’s assets, within the install folder:
**C:\Program Files (x86)\Steam\steamapps\common\rocketleague\TAGame\CookedPCConsole**

Meaning that the script for me is:

```sh
@echo off
echo "%~1"
echo F|xcopy /y "%~1" "C:\Program Files (x86)\Steam\steamapps\common\rocketleague\TAGame\CookedPCConsole\Labs_Utopia_P.upk"
```
**<code><PreferenceSetting storeKey="rlmm-path-rl" defaultValue="C:\Games\SteamApps\common\rocketleague\" type="input" :renderValue="true" />TAGame\CookedPCConsole</code>**

For ease of use, I copy this script into the folder of each of my in-progress maps.

Expand All @@ -68,6 +94,8 @@ If you want to have an animated skysphere around your world, use one of the Ligh

After making the project, the first thing you are going to want to do is save your new project with a better name than Untitled-3. I recommend putting it in a dedicated folder such as:

`{UDK Folder}\UDKGame\Content\Maps\MyNewMap`
<code>
<PreferenceSetting storeKey="rlmm-path-udk" defaultValue="C:\UDK\RLMM\" type="input" :renderValue="true" />UDKGame\Content\Maps\MyNewMap
</code>

It is no problem at all to change the name of a project after the fact, so don’t feel like you are locked in to a folder name or a project name.
2 changes: 1 addition & 1 deletion docs/essential/06_udk_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: 3
---
# UDK Basics

## Hello UDK
## UDK Hotkeys

### The Hottest Hotkeys

Expand Down
1 change: 0 additions & 1 deletion docs/resources/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ More Recent/Thorough Guides At The Top

## 2021

* [Simple Shark's RLMM Tutorial Series](https://www.youtube.com/playlist?list=PLIomqmQFYkVTl2FI2YBGzGuUZWSvZnS9d)
* [Plumato's How to Play Steam Workshop Maps](https://youtu.be/wO_ApfzdLSM)
* [CodeRed's How to Make a Rocket League Map](https://www.youtube.com/watch?v=3RODPYNN1u8)
* [World of Level Design](https://www.worldofleveldesign.com/categories/cat-udk.php)
Expand Down
21 changes: 2 additions & 19 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading