Skip to content

Commit 801d37b

Browse files
update installation and setup parts (#69)
* update installation and setup parts * fix: update package installations * Update 03_installing.md
1 parent 089e727 commit 801d37b

7 files changed

Lines changed: 66 additions & 60 deletions

File tree

docs/.vitepress/config/sidebar.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ const sidebar: Sidebar = {
6060
text: 'Installing',
6161
link: 'installing',
6262
},
63-
{
64-
text: 'Dummy Classes',
65-
link: 'dummy_classes',
66-
},
63+
// {
64+
// text: 'Dummy Classes',
65+
// link: 'dummy_classes',
66+
// },
6767
{
6868
text: 'Project setup',
6969
link: 'project_setup',

docs/essential/02_clarifications.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ One frequently asked question is “why do we have to use UDK?” Rocket League
99

1010
**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.
1111

12-
## Unreal Engine 4
12+
## Unreal Engine 4/5
1313

1414
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.**
1515

16+
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.
17+
1618
## File Extensions
1719

1820
![Windows settings menu for file explorer](/images/udk/essential/clarification_extensions.png "Don't not not hide")

docs/essential/03_installing.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,16 @@ title: Installing
99
* A full-featured 3D modeling program like [Blender](https://www.blender.org)
1010
* 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.
1111

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

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

16-
### RocketLeagueMapmaking UDK RL Setup Script <Badge text="recommended" type="tip"/>
17-
18-
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.
16+
[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.
1917

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

22-
### Newk’s UDK Simple Setup
23-
24-
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.
25-
26-
* [RocketLeagueMods Link](https://rocketleaguemods.com/mods/udk-2015-simple-setup/)
27-
28-
:::warning Setup steps
29-
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
30-
:::
21+
<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>
3122

3223
## Running the Installer
3324

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

4233
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.
4334

35+
> [!DANGER]
36+
> You cannot choose a project name with a space or other special characters!
37+
> This could give you trouble later, such as when running installers.
38+
4439
Twiddle your thumbs for a few minutes as it installs prerequisites and then installs UDK.
4540

4641
Ignore the extra options, and complete the install.
4742

48-
## Things to Change
49-
50-
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.
51-
5243
:::danger Manual Installation
53-
If you are going to install UDK manually: don’t launch it, because we have some things to change.
44+
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.
45+
46+
Before continuing, [read more](./04_dummy_classes.md) about the files that need to be changed.
47+
This list is not updated recently and the Dummy classes repository can have more changes in Core and Engine classes!
5448
:::

docs/essential/05_project_setup.md

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,53 @@ title: Project Setup
77

88
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.
99

10+
:::info Guide paths
11+
12+
To customize your guide experience, you can change the paths to your installation. These settings are saved locally in the browser only.
13+
14+
<PreferenceSetting
15+
storeKey="rlmm-path-udk"
16+
defaultValue="C:\UDK\RLMM\"
17+
type="input"
18+
:resetOptions="{ enabled: true }"
19+
>
20+
21+
UDK Installation folder
22+
</PreferenceSetting>
23+
24+
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.
25+
26+
<PreferenceSetting
27+
storeKey="rlmm-path-rl"
28+
defaultValue="C:\Games\SteamApps\common\rocketleague\"
29+
type="input"
30+
:resetOptions="{ enabled: true }"
31+
>
32+
33+
Rocket League installation folder
34+
</PreferenceSetting>
35+
36+
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.
37+
38+
You can change more preferences [in the settings page](/settings).
39+
40+
:::
41+
1042
## Folder Setup
1143

44+
> [!TIP]
45+
> If you used the installer package, these shortcuts are already created for you.
46+
1247
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.
1348

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

1953
* As mentioned in the [UDK install process](installing.md), everything will live inside `{UDK Folder}`
20-
* **Each individual custom map should live inside a folder within `{UDK Folder}\UDKGame\Content\Maps\`**
54+
* **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>**
2155
* In addition to these folders, I highly highly recommend making two Windows File Explorer shortcuts, or bookmarking these locations
22-
* One that points to `{CookedPCConsole}`
56+
* One that points to `{CookedPCConsole}`: <code><PreferenceSetting storeKey="rlmm-path-rl" defaultValue="C:\Games\SteamApps\common\rocketleague\" type="input" :renderValue="true" />TAGame\CookedPCConsole</code>
2357
* 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.
2458
* Keep these within the `\Maps\` folder
2559

@@ -31,7 +65,7 @@ I use Windows 10 and the Steam version of Rocket League, so please keep that in
3165
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.
3266
:::
3367

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

3670
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.
3771

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

4882
CookedPCConsole is the folder containing all of Rocket League’s assets, within the install folder:
49-
**C:\Program Files (x86)\Steam\steamapps\common\rocketleague\TAGame\CookedPCConsole**
50-
51-
Meaning that the script for me is:
52-
53-
```sh
54-
@echo off
55-
echo "%~1"
56-
echo F|xcopy /y "%~1" "C:\Program Files (x86)\Steam\steamapps\common\rocketleague\TAGame\CookedPCConsole\Labs_Utopia_P.upk"
57-
```
83+
**<code><PreferenceSetting storeKey="rlmm-path-rl" defaultValue="C:\Games\SteamApps\common\rocketleague\" type="input" :renderValue="true" />TAGame\CookedPCConsole</code>**
5884

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

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

6995
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:
7096

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

73101
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.

docs/essential/06_udk_intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ outline: 3
44
---
55
# UDK Basics
66

7-
## Hello UDK
7+
## UDK Hotkeys
88

99
### The Hottest Hotkeys
1010

docs/resources/guides.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ More Recent/Thorough Guides At The Top
2020

2121
## 2021
2222

23-
* [Simple Shark's RLMM Tutorial Series](https://www.youtube.com/playlist?list=PLIomqmQFYkVTl2FI2YBGzGuUZWSvZnS9d)
2423
* [Plumato's How to Play Steam Workshop Maps](https://youtu.be/wO_ApfzdLSM)
2524
* [CodeRed's How to Make a Rocket League Map](https://www.youtube.com/watch?v=3RODPYNN1u8)
2625
* [World of Level Design](https://www.worldofleveldesign.com/categories/cat-udk.php)

package-lock.json

Lines changed: 2 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)