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
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
strategy:
matrix:
# Set the same version as in Dockerfile
node: [18]
node: [22]
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
7 changes: 3 additions & 4 deletions .github/workflows/preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
strategy:
matrix:
# Set the same version as in Dockerfile
node: [18]
node: [22]
permissions:
contents: read
deployments: write
Expand All @@ -49,13 +49,12 @@ jobs:
run: npm run docs:build

- name: Publish to Cloudflare Pages
uses: cloudflare/pages-action@1
uses: cloudflare/wrangler-action@v3
id: cloudflare
with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
projectName: ${{ secrets.CLOUDFLARE_PROJECTNAME || 'rocketleaguemapmaking' }}
directory: docs/.vitepress/dist
command: pages deploy docs/.vitepress/dist --project-name=${{ secrets.CLOUDFLARE_PROJECTNAME || 'rocketleaguemapmaking' }}
# Enable GitHub deployments
gitHubToken: ${{ secrets.GITHUB_TOKEN }}

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ jobs:
strategy:
matrix:
# Run for both the node version used and the next major version
node: [18, 20]
node: [22, 24]
steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .ls-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ls:
.png: regex:logo_(\w|_|\d)+

images:
.png: not_regex:image\d+
.png: regex:!image\d+

# All images should be in the following folders only
'{blender,udk}/*':
Expand Down
14 changes: 7 additions & 7 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"MD013": false,
"MD024": false,
"MD025": false,
"MD029": false,
"MD033": false,
"MD034": false,
"MD045": false
"line-length": false,
"no-duplicate-heading": false,
"single-h1": false,
"ol-prefix": false,
"no-inline-html": false,
"no-bare-urls": false,
"no-alt-text": false
}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The project utilises `vitepress` in order to create pages for our documentation,

## Dependencies

1. Install [Node v18+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (or later). You can use [nvm](https://github.com/nvm-sh/nvm) to easily update Node.
1. Install [Node v22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) (or later). You can use [nvm](https://github.com/nvm-sh/nvm) to easily update Node.

- `node --version` should show at least `v18.19.0`. Lower versions have not been tested but may also work.
- `npm --version` should show at least `10.2.3`. Lower versions have not been tested but may also work.
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
ARG deploy_base_image="nginx:1.27.0-alpine"
ARG build_base_image="node:18.19.0-alpine3.19"
ARG build_base_image="node:22.22.1-alpine3.22"

# Use an intermediary image to do our builds, removing coupling from the machine executing commands and allowing us to
# trim the fat.
Expand Down
2 changes: 2 additions & 0 deletions docs/.vitepress/config/data/frontmatter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ const frontmatterKeys: FilterKey[] = [
'lastUpdated',
'editLink',
'footer',
'prev',
'next',
// theme-rlmm
'banner',
'blocks',
Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/config/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ export default defineConfigWithTheme<ThemeConfig>({

// Theme-rlmm options
router: {
// Apply the rewrites to redirect to the rewritten page
redirects: rewrites,
},

Expand Down
15 changes: 15 additions & 0 deletions docs/.vitepress/config/navbar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,45 @@ import {
export default <DefaultTheme.NavItem[]>[
{
text: 'Essentials',
activeMatch: '/essential/',
link: '/essential/'
},

{
text: 'Guide',
activeMatch: '/guide/',
items: [
{
text: 'UDK',
items: [
{
text: 'Editor',
activeMatch: '/guide/udk/',
link: '/guide/udk/start'
},
{
text: 'Kismet',
activeMatch: '/guide/kismet/',
link: '/guide/kismet/kismet'
},
{
text: 'Textures',
activeMatch: '/guide/textures/',
link: '/guide/textures/textures'
},
{
text: 'Multiplayer',
activeMatch: '/guide/multiplayer/',
link: '/guide/multiplayer/multiplayer'
},
{
text: 'Decryption',
activeMatch: '/guide/decryption/',
link: '/guide/decryption/'
},
{
text: 'Miscellaneous',
activeMatch: '/guide/misc/',
link: '/guide/misc/misc'
}
]
Expand All @@ -48,6 +56,7 @@ export default <DefaultTheme.NavItem[]>[
items: [
{
text: 'Guide',
activeMatch: '/blender/(?!fbx)',
link: '/guide/blender/blender'
},
{
Expand All @@ -61,9 +70,11 @@ export default <DefaultTheme.NavItem[]>[

{
text: 'Resources',
activeMatch: '/(cheatsheet|faq|tipstricks|resources)/',
items: [
{
text: 'Cheatsheets',
activeMatch: '/cheatsheet/',
link: '/cheatsheet/'
},
{
Expand All @@ -72,14 +83,17 @@ export default <DefaultTheme.NavItem[]>[
},
{
text: 'FAQ',
activeMatch: '/faq/',
link: '/faq/'
},
{
text: 'References',
activeMatch: '/resources/references/',
link: '/resources/references/guide'
},
{
text: 'Tips and Tricks',
activeMatch: '/tipstricks/',
link: '/tipstricks/'
},
{
Expand Down Expand Up @@ -108,6 +122,7 @@ export default <DefaultTheme.NavItem[]>[

{
text: 'More',
activeMatch: '/more/',
items: [
{
text: 'About',
Expand Down
3 changes: 2 additions & 1 deletion docs/.vitepress/config/util/rewrites.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ import { resolve } from 'node:path'

import type { UserConfig } from 'vitepress'

export type RewriteConfig = NonNullable<UserConfig['rewrites']>
// eslint-disable-next-line no-unused-vars
export type RewriteConfig = Exclude<NonNullable<UserConfig['rewrites']>, ((_id: string) => string)>

type RewriteFolderOptions =
| string
Expand Down
Binary file not shown.
7 changes: 7 additions & 0 deletions docs/.vitepress/theme/components/SettingsNav.vue
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ defineProps<{
background-color: var(--vp-c-bg-soft);
}

/* Hides the border on the menu from the original theme switch */
.VPMenu .group + .group {
border-top: unset !important;
padding: 0 12px 0 12px !important;
}

.nav-settings-item {
justify-content: space-between;
align-items: center;
Expand All @@ -50,6 +56,7 @@ defineProps<{

.nav-settings {
color: var(--vp-c-text-2);
padding-left: 10px;
font-size: 12px;
font-weight: 500;
}
Expand Down
3 changes: 3 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,8 @@ export default {
for (const [name, component] of components) {
ctx.app.component(name, component)
}

const theme = ctx.app.config.globalProperties.$theme
console.log(`Theme: ${theme.name} - v${theme.version}`)
},
} satisfies Theme
10 changes: 5 additions & 5 deletions docs/cheatsheet/01_stickywalls.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ pageClass: page-inline-images
<template #step-1>

Create a **New Asset** with **New** at the bottom left of the Content Browser:
![](/images/cheatsheets/stickywalls/image7.png)
![](/images/cheatsheets/stickywalls/button_new_asset.png)

or Right Click and select **New Physical Material**:

![](/images/cheatsheets/stickywalls/image8.png)
![](/images/cheatsheets/stickywalls/new_physicalmaterial.png)

</template>
<template #step-2>
Expand All @@ -26,14 +26,14 @@ or Right Click and select **New Physical Material**:
| **Name** | StickyWalls |
| **Factory** | PhysicalMaterial |

![](/images/cheatsheets/stickywalls/image3.png)
![](/images/cheatsheets/stickywalls/new_material_factory.png)

</template>
<template #step-3>

**Add** `PhysicalMaterialProperty_TA` with the blue arrow dropdown at the bottom of the next popup. Check **Enable Sticky Wheels**

![](/images/cheatsheets/stickywalls/image6.png)
![](/images/cheatsheets/stickywalls/phys_material_properties.png)

You may wish to create a secondary Sticky Walls with **Consider For Ground** disabled. The game will not end if the ball hits that surface at 0 seconds.

Expand All @@ -42,7 +42,7 @@ You may wish to create a secondary Sticky Walls with **Consider For Ground** dis

**Assign** to a Static Mesh Actor or Blocking Volume’s `Phys Material Override` slot with the green arrow

![](/images/cheatsheets/stickywalls/image1.png)
![](/images/cheatsheets/stickywalls/override_phys_material.png)

</template>
</steps>
Expand Down
10 changes: 6 additions & 4 deletions docs/cheatsheet/02_dummyassets.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,29 @@ pageClass: page-inline-images

**Add** them to UDKGame/Content and verify in the Content Browser:

![](/images/cheatsheets/dummyassets/image6.png)
![](/images/cheatsheets/dummyassets/download_steps.png)

</template>
<template #step-2>

**Right click** a map package and select **Fully Load:**

![](/images/cheatsheets/dummyassets/image2.png)
![](/images/cheatsheets/dummyassets/package_fully_load.png)

</template>
<template #step-3>

**Drag** an asset into the map, or **Right click** in the 3D editor and **Add** the object:

![](/images/cheatsheets/dummyassets/actor_add.png)

**Immediately open Properties** (F4) and put a useful name in the Tag field:

![](/images/cheatsheets/dummyassets/image1.png)
![](/images/cheatsheets/dummyassets/actor_tag.png)

Save Current Level will update the Scene tab, then sort by Tag to find the invisible Dummy Assets:

![](/images/cheatsheets/dummyassets/image3.png)
![](/images/cheatsheets/dummyassets/scene_tags.png)

</template>
</steps>
Expand Down
18 changes: 9 additions & 9 deletions docs/cheatsheet/03_collisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ pageClass: page-inline-images

**Drag** a valid .FBX mesh into your map package in UDK:

![](/images/cheatsheets/collisions/image6.png)
![](/images/cheatsheets/collisions/image2b.png)
![](/images/cheatsheets/collisions/image5.png)
![](/images/cheatsheets/collisions/fbx_mesh_blender.png)
![](/images/cheatsheets/collisions/arrow_down.png)
![](/images/cheatsheets/collisions/fbx_mesh_udk.png)

</template>
<template #step-2>

**Double click** it in the Content Browser and **uncheck the three checkmarks** at the bottom of the pane on the right:
**Double click** it in [the Content Browser](/essential/content_browser) and **uncheck the three checkmarks** at the bottom of the pane on the right:

![](/images/cheatsheets/collisions/image7.png)
![](/images/cheatsheets/collisions/mesh_settings.png)

</template>
<template #step-3>
Expand All @@ -27,18 +27,18 @@ pageClass: page-inline-images

Open its Properties:

**Uncheck** “Disable All Rigid Body”: ![](/images/cheatsheets/collisions/image10.png)
**Uncheck** “Disable All Rigid Body”: ![](/images/cheatsheets/collisions/prop_disable_rigid_body.png)

**Check** “Block Rigid Body”: ![](/images/cheatsheets/collisions/image3.png)
**Check** “Block Rigid Body”: ![](/images/cheatsheets/collisions/prop_block_rigid_body.png)

**Check** “Accepts Dynamic Decals” to allow the ball indicator circle: ![](/images/cheatsheets/collisions/image9.png)
**Check** “Accepts Dynamic Decals” to allow the ball indicator circle: ![](/images/cheatsheets/collisions/prop_accept_dyn_decals.png)

</template>
<template #step-4>

**Assign** the StickyWalls Physical Material to map geometry:

![](/images/cheatsheets/collisions/image8.png)
![](/images/cheatsheets/collisions/prop_phys_mat.png)

</template>
</steps>
Expand Down
Loading
Loading