WolvenKit

https://wiki.redmodding.org/wolvenkit/
Admin
WolvenKit is an open-source modding toolkit that provides asset import/export, file editing, project...
Tokens:54,314
Snippets:983
Trust Score:7.9
Update:5 months ago
Show doc for...
Tokens:
Raw
### Querying Documentation Example

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/import-export

Shows how to perform an HTTP GET request to query the documentation dynamically using the 'ask' query parameter.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/import-export.md?ask=<question>
```

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

### Tweak File Format Example (TweakDBID with Full Path)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Example for 'TweakDBID' type, using the full path of a flat or group.

```yaml
flats:
  myFlat.reference:
    type: TweakDBID
    value: myOtherFlat.cow
```

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

### Verify .NET Tool Installation

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/wolvenkit-console

Checks if the WolvenKit CLI has been successfully installed as a .NET tool by displaying its help information.

```bash
cp77tools -help
```

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

### Tweak File Format Example (TweakDBID with Shorthand)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Example for 'TweakDBID' type, using the hexadecimal hash and length shorthand.

```yaml
flats:
  myFlat.reference:
    type: TweakDBID
    value: TDBID:12345678:12
```

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

### Query WolvenKit Documentation via HTTP GET

Source: https://wiki.redmodding.org/wolvenkit/features

Perform an HTTP GET request to the documentation URL with an 'ask' query parameter to get dynamic information. Use this when the answer is not explicitly present on the page, requires clarification, or you want to retrieve related documentation sections.

```http
GET https://wiki.redmodding.org/wolvenkit/features.md?ask=<question>
```

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

### Install WolvenKit Console as a .NET Tool

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/wolvenkit-console

Installs the WolvenKit CLI globally using the .NET CLI. This makes the `cp77tools` command available system-wide.

```bash
dotnet tool install -g wolvenkit.cli
```

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

### Tweak File Format Example (Vector3)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Example for 'Vector3' type, declaring X, Y, and Z coordinates.

```yaml
flats:
  whereIam.position:
    type: Vector3
    value: 
      X: 0
      Y: 0
      Z: 0 
```

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

### Tweak File Format Example (raRef:CResource with Path)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Example for 'raRef:CResource' type, specifying a file path. Note the double backslashes for paths.

```yaml
      curvesPath:
          type: raRef:CResource
          value: "base\gameplay\vehicles\curves\muscle_car.vehcurveset"
```

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

### Tweak File Format Example (Flats)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Example of a .tweak file structure using the 'flats' declaration. This defines individual properties.

```yaml
flats:
  Mycustom.flat:
    type: Float
    value: 1.0
```

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

### Tweak File Format Example (Groups)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Example of a .tweak file structure using the 'groups' declaration. This defines records with members.

```yaml
groups:
  MyOtherCustomRecordOrGroup.mine:
    type: Vehicle
    members:
      affiliation:
        type: TweakDBID
        value: Factions.Unaffiliated 
      animals:
        type: array:String
        value:
          - cow
          - pig
          - horse
          - cat
```

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

### Tweak File Format Example (raRef:CResource with Integer)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Example for 'raRef:CResource' type, using an integer value instead of a file path.

```yaml
      curvesPath:
          type: raRef:CResource
          value: 5774411407796421038
```

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

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/wolvenkit/getting-started/troubleshooting

To get information not explicitly on the page, make an HTTP GET request with an 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://wiki.redmodding.org/wolvenkit/getting-started/troubleshooting.md?ask=<question>
```

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

### Get general help for Wolvenkit CLI

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage

Displays general help information and lists all available commands for the Wolvenkit CLI.

```bash
--help
```

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

### Query Wolvenkit Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/wait-it-can-do-that

Perform an HTTP GET request to the documentation URL with the 'ask' query parameter to get specific answers. The question should be natural language, specific, and self-contained.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/wait-it-can-do-that.md?ask=<question>
```

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

### Example appsettings.json Configuration

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/settings

This JSON file demonstrates a typical configuration for Wolvenkit.CLI, including settings for logging levels and export arguments for XBM and mesh files.

```json
{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Warning"
    }
  },
  "XbmExportArgs": {
    "Flip" : false,
    "UncookExtension": "dds"
  },
  "MeshExportArgs": {
    "UncookExtension": "glb",
    "WithMaterials": false
  }

}
```

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

### Query Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/wolvenkit-console

Demonstrates how to perform an HTTP GET request to query the documentation dynamically with a specific question.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/wolvenkit-console.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/video-and-audio-files-cli

To get information not explicitly on the page, make an HTTP GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/video-and-audio-files-cli.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/features/release-notes/legacy

Perform an HTTP GET request on the current page URL with the 'ask' query parameter to get dynamic documentation. The question should be specific and self-contained.

```http
GET https://wiki.redmodding.org/wolvenkit/features/release-notes/legacy.md?ask=<question>
```

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

### Install Group Policy Client Extensions

Source: https://wiki.redmodding.org/wolvenkit/getting-started/eli5-getting-started/prep-your-computer

Execute this command in an administrator CMD window to install the Group Policy Client Extensions. This complements the client tools for policy management.

```cmd
FOR %F IN ("%SystemRoot%\servicing\Packages\Microsoft-Windows-GroupPolicy-ClientExtensions-Package\~*.mum") DO ( DISM /Online /NoRestart /Add-Package:"%F" )
```

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

### Get File (Path)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Loads a file, prioritizing the project directory and then falling back to game archives. Use either a path or hash, and specify the output format.

```csharp
GetFile(path: string, openAs: OpenAs) → ? object
```

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

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/wolvenkit/getting-started/uninstall

To get additional information not present on the current page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://wiki.redmodding.org/wolvenkit/getting-started/uninstall.md?ask=<question>
```

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

### Get File (Hash)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Loads a file, prioritizing the project directory and then falling back to game archives. Use either a path or hash, and specify the output format.

```csharp
GetFile(hash: ulong, openAs: OpenAs) → ? object
```

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

### Query Documentation with GET Request

Source: https://wiki.redmodding.org/wolvenkit/guides/official

Perform an HTTP GET request on the current page URL with the `ask` query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, you need clarification, or want to retrieve related documentation.

```http
GET https://wiki.redmodding.org/wolvenkit/guides/official.md?ask=<question>
```

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

### Tweak File Format Example (Array with Brackets)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Alternative format for arrays within .tweak files, using square brackets and commas.

```yaml
      animals:
        type: array:String
        value: [ cow, pig, horse, cat ]
```

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

### Querying Documentation via HTTP GET

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/editor/properties

To get additional information not directly on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and in natural language.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/editor/properties.md?ask=<question>
```

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

### Querying Documentation via HTTP GET

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/blender-integration

To get additional information not present on the current page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and in natural language. This is useful for clarifications or retrieving related documentation.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/blender-integration.md?ask=<question>
```

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

### Dynamic Documentation Query

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wolvenkit-search-finding-files

To get more information not directly on this page, make an HTTP GET request to the page URL with the 'ask' query parameter followed by your question.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wolvenkit-search-finding-files.md?ask=<question>
```

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

### Install Group Policy Client Tools

Source: https://wiki.redmodding.org/wolvenkit/getting-started/eli5-getting-started/prep-your-computer

Use this command in an administrator CMD window to install the Group Policy Client Tools. This is necessary for managing system policies, especially on Windows Home editions.

```cmd
FOR %F IN ("%SystemRoot%\servicing\Packages\Microsoft-Windows-GroupPolicy-ClientTools-Package\~*.mum") DO ( DISM /Online /NoRestart /Add-Package:"%F" )
```

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

### Querying Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

To get additional information not directly present on the page, perform an HTTP GET request with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list.md?ask=<question>
```

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

### Query Documentation via HTTP GET

Source: https://wiki.redmodding.org/wolvenkit/help/community

Perform an HTTP GET request to query the documentation dynamically. Use this when the answer is not explicitly present, requires clarification, or you want to retrieve related sections.

```http
GET https://wiki.redmodding.org/wolvenkit/help/community.md?ask=<question>
```

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

### Query Documentation via API

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/scripting-with-wscript

Perform an HTTP GET request to query documentation dynamically with the 'ask' query parameter. The question should be specific and self-contained.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/scripting-with-wscript.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/import-export/models

Perform an HTTP GET request to query the documentation. The 'ask' query parameter should contain a specific, self-contained question in natural language.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/import-export/models.md?ask=<question>
```

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

### Get File From Project (Path)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Loads a file from the project using its path. Specify the desired output format using the 'openAs' parameter.

```csharp
GetFileFromProject(path: string, openAs: OpenAs) → ? object
```

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

### Connected File Example

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/import-export

Illustrates how a source mesh file is connected to its corresponding exported GLB file in the 'raw' folder. This connection is crucial for successful importing.

```text
source/archive/base/path/your_file.mesh
source/raw/base/path/your_file.glb
```

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

### Query Wolvenkit Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to ask a question. The question should be specific and in natural language. Use this when the answer is not explicitly present or for clarification.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app.md?ask=<question>
```

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

### Get help for a specific Wolvenkit CLI command

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage

Displays help information for a specific command, such as 'archive'.

```bash
archive -h
```

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

### Get File From Project (Hash)

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Loads a file from the project using its hash value. Specify the desired output format using the 'openAs' parameter.

```csharp
GetFileFromProject(hash: ulong, openAs: OpenAs) → ? object
```

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

### Unconnected File Example

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/import-export

Demonstrates a scenario where an exported file is not connected to its source due to naming or path discrepancies, preventing successful importing via the Import Tool.

```text
source/archive/base/path/your_file.mesh
source/raw/base/path/your_file_mesh_export.glb
```

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

### Query Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/editor/quest-editor

Perform an HTTP GET request to the current page URL with the 'ask' query parameter to dynamically query the documentation. Use this when the answer is not explicitly present, for clarification, or to retrieve related sections.

```HTTP
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/editor/quest-editor.md?ask=<question>
```

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

### Configure binfmt for Proton-GE

Source: https://wiki.redmodding.org/wolvenkit/getting-started/download

This configuration allows Linux to open Windows executables directly with Proton, replacing Wine. Ensure Proton-GE is installed system-wide and adjust paths as necessary for your distribution. Reloading systemd-binfmt is required after changes.

```bash
sudo ln -s /dev/null /etc/binfmt.d/wine.conf
sudo ln -s /dev/null /etc/binfmt.d/mono.conf
```

```bash
:DOSWin:M::MZ::/usr/bin/proton-ge:
```

```bash
sudo systemctl restart systemd-binfmt
```

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

### Query Documentation with 'ask' Parameter

Source: https://wiki.redmodding.org/wolvenkit/getting-started/eli5-getting-started/validate-functionality

Perform an HTTP GET request to a documentation URL, including the 'ask' query parameter with a natural language question. The response will contain a direct answer and relevant excerpts.

```http
GET https://wiki.redmodding.org/wolvenkit/getting-started/eli5-getting-started/validate-functionality.md?ask=<question>
```

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

### Perform HTTP GET Request to Query Documentation

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/editor/file-editor

Use this method to query the documentation dynamically when information is not directly available. The question should be specific and self-contained.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-app/editor/file-editor.md?ask=<question>
```

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

### Run WolvenKit Console from Downloaded Directory

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/wolvenkit-console

Executes the WolvenKit Console application directly from its extracted directory. This is useful if you haven't installed it as a .NET tool or added it to your system's PATH.

```bash
C:\Cyberpunk_Modding\WolvenKit.Console\Wolvenkit.CLI.exe -help
```

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

### Query Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/help/bug-reports

Perform an HTTP GET request to query the documentation dynamically. Use this when the answer is not explicitly present, requires clarification, or you want to retrieve related documentation sections.

```http
GET https://wiki.redmodding.org/wolvenkit/help/bug-reports.md?ask=<question>
```

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

### Query Documentation Dynamically

Source: https://wiki.redmodding.org/wolvenkit/modding-community

Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve specific information not explicitly present on the page. The question should be specific and in natural language.

```http
GET https://wiki.redmodding.org/wolvenkit/modding-community.md?ask=<question>
```

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

### Querying Documentation via API

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/settings

To get additional information not directly present on the page, you can make a GET request to the page URL with an 'ask' query parameter containing your question.

```http
GET https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/settings.md?ask=<question>
```

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

### Import Raw Files

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Convert raw files into REDengine format. The input path can be a single file or a folder. The output path is optional, and the `--keep` flag can be used if REDengine files already exist in the output folder.

```bash
import -p "INPUT PATH" -o "OUTPUT PATH" --keep
```

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

### GetDocuments

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Gets all documents from the docking manager.

```APIDOC
## GetDocuments

### Description
Gets all documents from the docking manager.

### Returns
- **? IList<ScriptDocumentWrapper>** - A list of all script document wrappers, or null if no documents are found.
```

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

### Load All Queries

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Retrieves all queries from the project, returning them as TweakDBID paths.

```csharp
GetQueries() → IEnumerable
```

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

### GetDocuments

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Gets all documents from the docking manager.

```APIDOC
## GetDocuments

### Description
Gets all documents from the docking manager.

### Method
AppScriptFunction

### Endpoint
GetDocuments
```

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

### GetTDBIDPath

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Tries to get a TweakDBID path from its hash.

```APIDOC
## GetTDBIDPath

### Description
Tries to get TweakDBID path from its hash.

### Parameters
#### Path Parameters
- **key** (ulong) - Required - The hash key

### Returns
- **? string** - The path of the hash, or null when undefined.
```

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

### GetFile

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Loads a file, checking the project first and then the game archives if not found in the project, using either its file path or hash.

```APIDOC
## GetFile

### Description
Loads a file from the project or archive (in this order) using either a file path or hash.

### Method
AppScriptFunction

### Endpoint
N/A

### Parameters
- **identifier**: (string) - The file path or hash of the file.

### Request Example
N/A

### Response
- **fileContent**: (string or binary) - The content of the file.
```

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

### Make WolvenKit executable

Source: https://wiki.redmodding.org/wolvenkit/getting-started/download

In some cases, you may need to grant execute permissions to the WolvenKit executable file on Linux.

```bash
chmod +x WolvenKit.exe
```

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

### GetArchiveFiles

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Gets a list of the files available in the game archives.

```APIDOC
## GetArchiveFiles

### Description
Gets a list of the files available in the game archives.

### Response
#### Success Response (200)
- **files** (IEnumerable) - A list of files in the game archives.
```

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

### GetActiveDocument

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Gets the current active document from the docking manager.

```APIDOC
## GetActiveDocument

### Description
Gets the current active document from the docking manager.

### Returns
- **? ScriptDocumentWrapper** - The active script document wrapper, or null if no document is active.
```

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

### GetActiveDocument

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Gets the current active document from the docking manager.

```APIDOC
## GetActiveDocument

### Description
Gets the current active document from the docking manager.

### Method
AppScriptFunction

### Endpoint
GetActiveDocument
```

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

### Import Logger Utility

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/scripting-with-wscript

Include the Logger.wscript utility library to assist with writing messages to the Wolvenkit log.

```javascript
import * as Logger from 'Logger.wscript';
```

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

### GetGameFile

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Gets the game file in the specified output type ('cr2w' or 'json').

```APIDOC
## GetGameFile

### Description
Gets the game file in the specified output type.

### Parameters
#### Query Parameters
- **type** (string) - Required - The output type of the game file ("cr2w" or "json")

### Response
#### Success Response (200)
- **file** (object?) - The game file object, or null if not found.
```

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

### Update Wolvenkit CLI globally

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage

Updates the globally installed Wolvenkit Command Line Tools to the latest version.

```bash
dotnet tool update --global wolvenkit.cli
```

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

### Get All Script Documents

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Retrieves a list of all script documents currently managed by the docking manager. Returns null if no documents are found.

```csharp
GetDocuments() → ? IList< ScriptDocumentWrapper >
```

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

### Get Active Script Document

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Retrieves the currently active script document from the docking manager. Returns null if no document is active.

```csharp
GetActiveDocument() → ? ScriptDocumentWrapper
```

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

### Run Wolvenkit CLI globally

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage

Executes the Wolvenkit CLI to uncook an archive file. This command can be run from any directory after global installation.

```bash
wolvenkit.cli uncook -p "D:\SteamLibrary\steamapps\common\Cyberpunk 2077\archive\pc\content\basegame_1_engine.archive"
```

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

### Load Game File From Project

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Loads a specified game file directly from the project's files, bypassing game archives. Use for custom content or modifications.

```csharp
LoadGameFileFromProject(path: string, type: string) → ? object
```

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

### Get Project Files

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Retrieves a list of files located within the project directory. Specify 'archive' or 'raw' to filter by folder type.

```csharp
GetProjectFiles(folderType: string) → List< string >
```

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

### Load All Records

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Retrieves all records from the project, returning them as TweakDBID paths.

```csharp
GetRecords() → IEnumerable
```

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

### Search Mesh Files by Archive Match

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wolvenkit-search-finding-files

This example shows the correct way to chain the 'archive' operator with a file type. The '>' operator is required for refinement.

```text
a:ArchiveXL_Netrunner > .mesh
```

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

### Get TweakDBID Path from Key

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Attempts to retrieve the TweakDBID path corresponding to a given hash key. Returns the path as a string, or null if the key is undefined.

```csharp
GetTDBIDPath(key: ulong) → ? string
```

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

### ShowSettings

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Shows the settings dialog for the supplied data. Returns true if settings were changed, false otherwise.

```APIDOC
## ShowSettings

### Description
Shows the settings dialog for the supplied data.

### Parameters
#### Request Body
- **data** (ScriptObject) - Required - A JavaScript object containing data

### Response
#### Success Response (200)
- **changed** (bool) - Returns true when the user changed the settings, otherwise it returns false
```

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

### Convert REDengine File to Human Readable Form

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/command-list

Use this command to convert a REDengine file into a human-readable format. Replace `<PATH TO FILE>` with the actual path to your file.

```bash
cr2w -s "<PATH TO FILE>"
```

```bash
convert -s "<PATH TO FILE>"
```

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

### Create Instance as JSON

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Creates a new instance of a specified class and returns it as a JSON string. Requires the class name as input.

```csharp
CreateInstanceAsJSON(className: string) → ? object
```

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

### ShowSettings

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Shows the settings dialog for the supplied data.

```APIDOC
## ShowSettings

### Description
Shows the settings dialog for the supplied data.

### Method
AppScriptFunction

### Endpoint
ShowSettings
```

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

### Import and Apply Textures with WolvenKit CLI

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-cli/usage/textures-cli

The `import` command applies modified TGA textures to their corresponding XBM files. Ensure both .tga and .xbm files are present in the specified modded folder.

```bash
import -p "MODDED FOLDER PATH" -k
```

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

### Get Paths from JSON Data

Source: https://wiki.redmodding.org/wolvenkit/modding-community/exporting-vehicles

A generator function that recursively traverses JSON data to find and yield ResourcePath values. It handles nested objects and checks for empty paths.

```javascript
// begin helper functions
function* GetPaths(jsonData) {
    for (let [key, value] of Object.entries(jsonData || {})) {
        if (value instanceof TypeHelper.ResourcePath && !value.isEmpty()) {
            yield value.value;
        }

        if (typeof value === "object") {
            yield* GetPaths(value);
        }
    }
}
```

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

### Get Filename from Path

Source: https://wiki.redmodding.org/wolvenkit/modding-community/exporting-vehicles

Extracts the filename from a given string path, supporting both backslash and forward slash separators. This utility function is useful for isolating file names from their full paths.

```javascript
function get_filename(str) {
    return str.split('\\').pop().split('/').pop();
}
```

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

### ProgramVersion

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Returns the current WolvenKit version as a string.

```APIDOC
## ProgramVersion

### Description
Returns the current WolvenKit version.

### Response
#### Success Response (200)
- **version** (string) - The current WolvenKit version
```

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

### Load All Flats

Source: https://wiki.redmodding.org/wolvenkit/wolvenkit-app/usage/wscript-api-docs

Retrieves all flats from the project, returning them as TweakDBID paths.

```csharp
GetFlats() → IEnumerable
```
Tokens:
Raw