RedM Native Reference

https://rdr3natives.com/
Admin
A comprehensive reference for RedM natives (functions) used in Red Dead Redemption 2, including a...
Tokens:844
Snippets:8
Trust Score:4.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Integrate Documentation with Text Editors

Source: https://context7.com/context7/rdr3natives/llms.txt

Demonstrates how to open the documentation repository in popular text editors like VS Code, Vim, or Neovim. It also shows a script example for automated lookups of native function documentation within your own scripts.

```bash
# Integrate with your text editor
# For VS Code:
code .

# For vim/neovim:
vim index.md

# For automated lookups in scripts:
NATIVE_NAME="GET_PLAYER_PED"
grep -A 10 "$NATIVE_NAME" . -r 2>/dev/null || \
  echo "Native $NATIVE_NAME documentation not found in current files"
```

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

### Contribute Documentation Updates via Git

Source: https://context7.com/context7/rdr3natives/llms.txt

Guides through the process of contributing documentation changes. It includes creating a new branch, staging changes, committing with a descriptive message, pushing to the remote, and creating a pull request using the GitHub CLI.

```bash
# Create a new branch for your documentation update
git checkout -b docs/update-natives

# Stage your documentation changes
git add .

# Commit with descriptive message
git commit -m "docs: add PLAYER namespace native functions"

# Push to remote
git push origin docs/update-natives

# Create pull request via GitHub CLI
gh pr create --title "Update native documentation" \
  --body "Added comprehensive documentation for PLAYER namespace natives"
```

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

### Display Main Index Content

Source: https://context7.com/context7/rdr3natives/llms.txt

Displays the content of the index.md file, serving as the main documentation index for the RedM Native Reference. It lists key sections like JOAAT Hash Calculator and RDR2 Object Galleries.

```bash
cat index.md
```

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

### Clone RDR3 Natives Repository

Source: https://context7.com/context7/rdr3natives/llms.txt

Clones the RDR3 Natives documentation repository from GitHub to a local machine. This command is the first step to accessing and working with the documentation offline. It also includes commands to navigate into the directory and list its contents.

```bash
git clone https://github.com/username/rdr3natives.git
cd rdr3natives

# View available documentation files
ls -la
```

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

### Display README Content

Source: https://context7.com/context7/rdr3natives/llms.txt

Displays the content of the README.md file, which contains basic repository information and source attribution. This is useful for understanding the project's origin and purpose.

```bash
cat README.md
```

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

### Search Native Functions in Documentation

Source: https://context7.com/context7/rdr3natives/llms.txt

Searches the documentation files for specific native functions or game features. `grep -r "PLAYER::" .` searches for natives in the PLAYER namespace, while `grep -ri "inventory\|weapon\|horse" .` performs a case-insensitive search for related features.

```bash
# Search for specific native functions (when documentation is expanded)
grep -r "PLAYER::" . 2>/dev/null || echo "Documentation files not yet expanded"

# Search for specific game features
grep -ri "inventory\|weapon\|horse" . 2>/dev/null || echo "Feature-specific docs not yet available"
```

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

### Update Documentation from Repository

Source: https://context7.com/context7/rdr3natives/llms.txt

Fetches and merges the latest documentation updates from the remote repository's main branch. `git diff HEAD~1 HEAD` shows changes in the last commit, and `git log --stat -1` displays file modifications in the most recent commit.

```bash
# Fetch and merge latest changes
git pull origin main

# Check what changed
git diff HEAD~1 HEAD

# View file modifications
git log --stat -1
```

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

### View Git Commit History

Source: https://context7.com/context7/rdr3natives/llms.txt

Displays the commit history of the repository. `git log --oneline` shows a condensed view of recent commits, while `git ls-tree -r HEAD --name-only` lists all tracked files in the current commit. This helps in tracking documentation updates.

```bash
# View recent commits
git log --oneline

# View all tracked files
git ls-tree -r HEAD --name-only
```
Tokens:
Raw