Ready or Not Modding Guide

https://unofficial-modding-guide.com/
Admin
A comprehensive community-driven guide for modding Ready or Not, covering map creation, AI...
Tokens:41,405
Snippets:355
Trust Score:6.2
Update:6 months ago
Show doc for...
Tokens:
Raw
### Create Pak to Custom Directory

Source: https://unofficial-modding-guide.com/posts/batchfiles

Packages a folder into a .pak file and moves it directly to the game's installation directory. Useful for rapid testing of mods.

```batch
@if "%~1"=="" goto skip
::REPLACE WITH YOUR DIRECTORY
@set output_location=C:\Program Files (x86)\Steam\steamapps\common\Ready Or Not\ReadyOrNot\Content\Paks
@setlocal enableextensions
@pushd %~dp0
@echo %output_location%%~n1.pak
@echo "%~1\*.*" "../../../ReadyOrNot/" >filelist.txt
.\UnrealPak.exe "%output_location%\%~n1.pak" -create=filelist.txt -compress
@popd
@pause
:skip
```

--------------------------------

### Initialize and Load Item Data in Python

Source: https://unofficial-modding-guide.com/posts/uassetautomation

This Python script initializes various item lists for weapons, tacticals, and helmets, and loads item data from a JSON file. It defines a custom `ItemDataStruct` for organizing item information. This setup is crucial for managing game items and their properties.

```python
import copy, json
from ItemDataStruct import ItemDataStruct

f = open('json/ItemData.json')
data = json.load(f)

primary_weapons = []
primary_weapons.append(ItemDataStruct("P90", "/Game/Blueprints/Items/WeaponsRevised/Primary_P90(0)", "Default__Primary_P90_C(0)", "Primary_P90_C(0)", "SMG"))

primary_weapons.append(ItemDataStruct("Primary_M16A4", "/Game/Blueprints/Items/WeaponsRevised/Primary_M16A4(0)", "Default__Primary_M16A4_C(0)", "Primary_M16A4_C(0)", "AR"))

primary_weapons.append(ItemDataStruct("Primary_Saiga12", "/Game/Blueprints/Items/WeaponsRevised/Primary_Saiga12(0)", "Default__Primary_Saiga12_C(0)", "Primary_Saiga12_C(0)", "Shotgun"))

secondary_weapons = []
secondary_weapons.append(ItemDataStruct("P250", "/Game/Blueprints/Items/WeaponsRevised/Secondary_P250(0)", "Default__Secondary_P250_C(0)", "Secondary_P250_C(0)", "Pistol"))

tacticals = []
tacticals.append(ItemDataStruct("9Banger", "/Game/Blueprints/Items/WeaponsRevised/Grenade_9Banger_V2(0)", "Default__Grenade_9Banger_V2_C(0)", "Grenade_9Banger_V2_C(0)", "Grenade"))

helmets = []
helmets.append(ItemDataStruct("Helmet_UpArmor", "/Game/Blueprints/Items/ArmorRevised/Helmet_UpArmor(0)", "Default__Helmet_UpArmor_C(0)", "Helmet_UpArmor_C(0)", "Helmet"))

last_import_index = len(data["Imports"])
```

--------------------------------

### Load Map via Unreal Engine Console

Source: https://unofficial-modding-guide.com/posts/mapping_gettingstarted

Command to load a specific map directly from the game console. Requires the Console Unlocker mod to be installed.

```text
open YOURMAPNAME
```

--------------------------------

### Configure Engine.ini for QuickMap

Source: https://unofficial-modding-guide.com/posts/quickcook

This snippet shows how to add the necessary override to the Engine.ini file to enable QuickMap. Ensure you add an empty line before the override and remove it or update it after major game updates.

```ini
[/Script/EngineSettings.GameMapsSettings]
GameDefaultMap=/Game/QuickCook/QuickMap.QuickMap
```

--------------------------------

### Create Pak from Folder (UE 5.3)

Source: https://unofficial-modding-guide.com/posts/batchfiles

Automates the creation of a .pak file from a dragged-in folder. It generates a file list, applies Oodle/Kraken compression, and outputs the result in the script directory.

```batch
@setlocal ENABLEDELAYEDEXPANSION
@if "%~1"=="" goto skip
@setlocal enableextensions
@pushd %~1
(for /R %%f in (*) do @set "filePath=%%f" & set "relativePath=!filePath:%~1=!" & @echo "%%f" "../../../ReadyOrNot!relativePath!")>"%~dp0/filelist.txt"
@pushd %~dp0
:: -compresslevel=4 for Normal, -compresslevel=-4 for uncompressed hyperfast paking
.\UnrealPak.exe "%~1.pak" -create=filelist.txt -compress -compressionformats=Oodle -compressmethod=Kraken -compresslevel=4
@popd
@pause
:skip
```

--------------------------------

### Get Last Import Index in Python

Source: https://unofficial-modding-guide.com/posts/uassetautomation

This Python code retrieves the current number of imports in the game's data by checking the length of the 'Imports' list. This value is crucial for correctly indexing new imports.

```python
last_import_index = len(data["Imports"])
```

--------------------------------

### Automate Map Packaging with UnrealPak

Source: https://unofficial-modding-guide.com/posts/mapping_gettingstartedue5

A Windows batch script that generates a file list from a directory and uses UnrealPak.exe to compress the content into a .pak file. It requires the Unreal Engine binary path and specific compression settings for optimal game performance.

```batch
@setlocal ENABLEDELAYEDEXPANSION
@if "%~1"=="" goto skip
@setlocal enableextensions
@pushd %~1
(for /R %%f in (*) do @set "filePath=%%f" & set "relativePath=!filePath:%~1=!" & @echo "%%f" "../../../ReadyOrNot!relativePath!")>"%~dp0/filelist.txt"
@pushd %~dp0
::-compresslevel=4 for Normal, -compresslevel=-4 for uncompressed hyperfast paking
.\UnrealPak.exe "%~1.pak" -create=filelist.txt -compress -compressionformats=Oodle -compressmethod=Kraken -compresslevel=4
@popd
@pause
:skip
```

--------------------------------

### INI Configuration for Custom Difficulty

Source: https://unofficial-modding-guide.com/posts/mapping_CustomDifficulty

This INI configuration sets up a custom difficulty tag and lists it. The `bIsHidden` parameter ensures this difficulty is not selectable in the game's UI, making it suitable for map-specific settings.

```ini
[Info]
 DifficultyGameplayTag = CustomDifficulty.ExampleMap.Standard
 DifficultyNameKey = 
 DifficultyDescriptionKey = DO NOT USE
 bIsHidden = true

[/Script/GameplayTags.GameplayTagsList]
GameplayTagList=(Tag="CustomDifficulty.ExampleMap.Standard",DevComment="")
```

--------------------------------

### INI Configuration for AI Spawn Parameters

Source: https://unofficial-modding-guide.com/posts/mapping_CustomDifficulty

This INI section defines the AI spawn parameters for a custom difficulty. It includes minimum and maximum counts for civilians and suspects, and enables the use of spawn groups with specific parameters for Group 1.

```ini
[RoN_DifficultyExampleMap]
MinCivilians = 1
MaxCivilians = 10
MinSuspects = 1
MaxSuspects = 10
UseSpawnGroups = true
MinSuspects_Group1 = 1
MinSuspects_Group1 = 3
MinCivilians_Group1 = 1
MaxCivilians_Group1 = 1 ; use semi colons for comments
```

--------------------------------

### Automate Unreal Engine Map Packaging with Batch Script

Source: https://unofficial-modding-guide.com/posts/mapping_gettingstarted

A Windows batch script used to automate the creation of .pak files from a staging directory. It generates a file list and invokes UnrealPak.exe with compression enabled.

```batch
@if "%~1"=="" goto skip
@setlocal enableextensions
@pushd %~dp0
@echo "%~1\*.*" "../../../ReadyOrNot/" >filelist.txt
.\UnrealPak.exe "%~1.pak" -create=filelist.txt -compress
@popd
@pause
:skip
```

--------------------------------

### Populate ItemData Arrays in Python

Source: https://unofficial-modding-guide.com/posts/uassetautomation

This Python code demonstrates how to populate arrays for different weapon categories (primary, secondary, tacticals, helmets) using the ItemDataStruct. Each item is instantiated with its specific game asset paths and types.

```python
primary_weapons = []
primary_weapons.append(ItemDataStruct("P90", "/Game/Blueprints/Items/WeaponsRevised/Primary_P90(0)", "Default__Primary_P90_C(0)", "Primary_P90_C(0)", "SMG"))

primary_weapons.append(ItemDataStruct("Primary_M16A4", "/Game/Blueprints/Items/WeaponsRevised/Primary_M16A4(0)", "Default__Primary_M16A4_C(0)", "Primary_M16A4_C(0)", "AR"))

primary_weapons.append(ItemDataStruct("Primary_Saiga12", "/Game/Blueprints/Items/WeaponsRevised/Primary_Saiga12(0)", "Default__Primary_Saiga12_C(0)", "Primary_Saiga12_C(0)", "Shotgun"))

secondary_weapons = []
secondary_weapons.append(ItemDataStruct("P250", "/Game/Blueprints/Items/WeaponsRevised/Secondary_P250(0)", "Default__Secondary_P250_C(0)", "Secondary_P250_C(0)", "Pistol"))

tacticals = []
tacticals.append(ItemDataStruct("9Banger", "/Game/Blueprints/Items/WeaponsRevised/Grenade_9Banger_V2(0)", "Default__Grenade_9Banger_V2_C(0)", "Grenade_9Banger_V2_C(0)", "Grenade"))

helmets = []
helmets.append(ItemDataStruct("Helmet_UpArmor", "/Game/Blueprints/Items/ArmorRevised/Helmet_UpArmor(0)", "Default__Helmet_UpArmor_C(0)", "Helmet_UpArmor_C(0)", "Helmet"))
```

--------------------------------

### Automate Unreal Engine 5 .pak file extraction with Batch script

Source: https://unofficial-modding-guide.com/posts/thebasics

A Windows batch script to automate the extraction of .pak files using the UnrealPak utility. Users drag a .pak file onto the script to extract its contents into a folder of the same name.

```batch
@if "%~1"=="" goto skip
@setlocal enableextensions
@pushd %~dp0
md "%~dpn1\"
.\UnrealPak.exe %1 -extract "%~dpn1\\"  -extracttomountpoint
@popd
@pause
:skip
```

--------------------------------

### Map attachments and parse ItemDataTable

Source: https://unofficial-modding-guide.com/posts/uassetautomation

This script demonstrates how to define attachment socket mappings and iterate through a JSON-based ItemDataTable to inject compatible attachments into weapon configurations. It uses the copy module to duplicate attachment structures and appends them if they do not already exist.

```python
for item in data["Exports"][0]["Table"]["Data"]:
    for item_data in item["Value"]:
	    if item_data["Name"] == "AvailableUnderbarrelAttachments(0)":
            name = item["Value"][0]["CultureInvariantString"]
            try:
                comp_attachments = weapon_to_attachments[name]
            except:
                continue

            attachments_to_add = []
            for under in all_under:
                if all_under[under] in comp_attachments:
                    attachments_to_add.append(under)

            for attachment in attachments_to_add:
                copied = copy.deepcopy(attachment_dic_format)
                copied["Value"] = attachment
                if copied not in item_data["Value"]:
                    item_data["Value"].append(copied)
            continue
```

--------------------------------

### Add Imports for Weapon Data in Python

Source: https://unofficial-modding-guide.com/posts/uassetautomation

This Python code constructs and appends import dictionaries to the game's data. It defines imports for the weapon's location, class, and default blueprint, ensuring the game recognizes the new weapon assets.

```python
dic_1 = {'$type': 'UAssetAPI.Import, UAssetAPI', 'ClassPackage': '/Script/CoreUObject(0)', 'ClassName': 'Package(0)', 'ObjectName': weapon_struct.location, 'OuterIndex': 0}
last_import_index += 1
dic_2 = {'$type': 'UAssetAPI.Import, UAssetAPI', 'ClassPackage': '/Script/Engine(0)', 'ClassName': 'BlueprintGeneratedClass(0)', 'ObjectName': weapon_struct.clas, 'OuterIndex': -last_import_index}
last_import_index += 1
dic_3 = {'$type': 'UAssetAPI.Import, UAssetAPI', 'ClassPackage': weapon_struct.location, 'ClassName': weapon_struct.clas, 'ObjectName': weapon_struct.default, 'OuterIndex': -(last_import_index-1)}
last_import_index += 1

data["Imports"].append(dic_1)
data["Imports"].append(dic_2)
data["Imports"].append(dic_3)
```
Tokens:
Raw