SAMMI Extensions
Palworld Paldex
Palworld Paldex is an extension for SAMMI that allows you to search for Pals in Palworld Paldex and display their stats.
Features
- Search for Pals by Name, Paldex Number, Type, Suitability, or Drop.
- Get detailed stats for each Pal, including name, description, types, and more.
- Easy integration with your SAMMI.
- Premade deck with all available commands, including example Twitch Chat triggers.
API Usage
Paldeck Palworld utilizes code from an API under the MIT license, available at this repository, deployed on our server. Access is reserved exclusively for this SAMMI extension, and unauthorized external use is prohibited.
Setup
Quick Start
- Install the extension. You can follow the Extension Install Guide.
- Open Bridge. It must be running for the extension to work.
- Review the premade deck "Palworld Paldex" for available extension commands.
Command Usage Reminder
These commands require a waiting period before 'Save Variable As' is populated. Use the Wait Until Variable Exists command, and remember to delete the variable you're waiting for beforehand.
Get Pal By Name
Allows you to search for a Pal by name and retrieve its stats. Use the Palworld Paldex Get Pal command with the following parameters:
| Parameter | Description | Example |
|---|---|---|
| Get Pal By | How you want to search for the Pal | Name |
| Max Amount | N/A when searching by Name | N/A |
| Input | Name of the Pal (case insensitive) | Relaxaurus |
| Save Variable As | Variable to save the result, returns empty string if no results | result |
Get Pal By Paldex Number
Search for a Pal by its Paldex Number and retrieve its stats. Use the Palworld Paldex Get Pal command with:
| Parameter | Description | Example |
|---|---|---|
| Get Pal By | How you want to search for the Pal | Paldex Number |
| Max Amount | N/A when searching by Paldex Number | N/A |
| Input | Paldex Number (leading zeroes required) | 050 |
| Save Variable As | Variable to save the result, returns empty string if no results | result |
Get Pal By Type
Search for a Pal by its Type and get its stats. Use the Palworld Paldex Get Pal command with:
| Parameter | Description | Example |
|---|---|---|
| Get Pal By | How you want to search for the Pal | Type |
| Max Amount | Max Pals returned for this Type | 5 |
| Input | Type you're searching for | water |
| Save Variable As | Variable to save the result, returns empty string if no results t | result |
Get Pal By Suitability
Search for a Pal by its Suitability (e.g., watering or transporting). Use the Palworld Paldex Get Pal command with:
| Parameter | Description | Example |
|---|---|---|
| Get Pal By | How you want to search for the Pal | Suitability |
| Max Amount | Max Pals returned for this suitability | 5 |
| Input | Suitability (case insensitive) | watering |
| Save Variable As | Variable to save the result, returns empty string if no results | result |
Get Pal By Drop
Search for a Pal by its Drop when captured or killed, and get its stats. Use the Palworld Paldex Get Pal command with:
| Parameter | Description | Example |
|---|---|---|
| Get Pal By | How you want to search for the Pal | Drop |
| Max Amount | Max Pals returned for this drop | 5 |
| Input | Drop you're searching for | leather |
| Save Variable As | Variable to save the result, returns empty string if no results | result |
General Information
Each search will return an object (for Name or Paldex Number searches) or an array of objects (for other types). Detailed Pal information includes:
name: Pal's name
key: Paldex Number
description: Pal description
aura: - description: Abilities of the aura.
- name: Name of the aura.
types: Array of all Pal types
drops: Array of droppable items.
image: URL of the Pal's wiki image
suitabilities: Array of suitable activities.
suitability: Object of all suitabilities and their levels
Example for Relaxaurus entry:
{
"name": "relaxaurus",
"key": "085",
"description": "Contrary to its blasé appearance, it's quite ferocious.",
"aura": {
"description": "Can be ridden.",
"name": "Hungry Missile"
},
"types": ["dragon", "water"],
"drops": ["high quality pal oil", "ruby"],
"image": "https://static.wikia.nocookie.net/palworld/images/0/01/Relaxaurus_menu.png/",
"suitabilities": ["watering", "transporting"],
"suitability": [
{ "type": "watering", "level": 2 },
{ "type": "transporting", "level": 1 }
]
}
Get Help
Please see Troubleshooting for common extensions issues.