Javalent's Plugins for Obsidian

https://plugins.javalent.com
Admin
Javalent's Plugins for Obsidian offers a collection of tools, including fantasy system plugins for...
Tokens:4,684
Snippets:56
Trust Score:4.9
Update:8 months ago
Show doc for...
Tokens:
Raw
### Basic Statblock Code Block Syntax

Source: https://plugins.javalent.com/statblocks

This code block demonstrates the fundamental syntax for creating a statblock using the Fantasy Statblocks plugin. It specifies the type of block as 'statblock' and indicates a 'creature' entry, serving as the starting point for defining a creature's statistics.

```yaml
```statblock
creature:
```
```

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

### Enable Dice Roller Integration in Statblocks

Source: https://plugins.javalent.com/statblocks/readme/code-block

This code block shows how to enable the Dice Roller plugin integration within a Fantasy Statblock. By setting `dice: true`, the plugin will parse common dice roll strings within the statblock for interactive dice rollers. This requires the Dice Roller plugin to be installed and enabled, and either the "Integrate Dice Roller" setting to be on or the `dice: true` key-value pair to be present.

```markdown
```statblock
# This is like.. config!
dice: true
layout: Basic Pathfinder 2e Layout

# Statblock Starts
name: "Shápsín"
```
```

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

### Configure Columns for Statblock Layout

Source: https://plugins.javalent.com/statblocks/readme/code-block

This code block demonstrates how to configure the column layout for a Fantasy Statblock. The `columns` key sets the desired number of columns, while `forceColumns: true` ensures the statblock is always split into the specified number of columns, regardless of content height. `columnHeight` can be used to set a maximum height for these columns.

```markdown
```statblock
# This is like.. config!
dice: true
render: true
layout: Basic Pathfinder 2e Layout
columns: 2
forceColumns: true
columnHeight: 750px

# Statblock Starts
name: "Shápsín"
```
```

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

### YAML Frontmatter for Fantasy Statblocks Plugin

Source: https://plugins.javalent.com/statblocks

This YAML frontmatter is used to define metadata for a Fantasy Statblocks entry. It includes aliases, a description, a permalink, and tags, which help in organizing and referencing the statblock within Obsidian.

```yaml
aliases: [Fantasy Statblocks, Statblocks]
description: "Fantasy Statblocks is a powerful table-top roleplaying plugin that allows you to easily create and manage statblock layouts within Obsidian."
permalink: statblocks
publish: true
tags: [Statblocks]
```

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

### Configure Statblock Layout and Name

Source: https://plugins.javalent.com/statblocks/readme/code-block

This snippet demonstrates how to define the layout and name for a Fantasy Statblock using a code block. The 'layout' key specifies the Statblock Layout name, which must exactly match a name in your Statblock settings. The 'name' field is a required field for the statblock entity.

```markdown
```statblock
# This is like.. config!
layout: Basic Pathfinder 2e Layout

# Statblock Starts
name: "Shápsín"
```
```

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

### Settings Search Plugin API for Dynamic Settings

Source: https://plugins.javalent.com/settings-search

This TypeScript code defines the interface for resources and provides functions to add, remove, and clear dynamically registered settings within the Obsidian Settings Search plugin. It allows other plugins to interface with the search functionality.

```typescript
interface Resource {
    //Id of your settings tab. This is usually the ID of your plugin as defined in the manifest.
    tab: string;
    //Name of your settings tab. This is usually the name of your plugin as defined in the manifest. This is used to organize the settings under headers when searching.
    name: string;
    //The name of the setting to add.
    text: string;
    //An optional description string to add to the setting.
    desc: string;
}

/**
 * Add an arbitrary number of resources to the settings search.
 * Returns a function that can be used to remove the registered resources.
 */
SettingsSearch.addResources(...resources: Resource[]);

/**
 * Remove an arbitrary number of resources from the settings search.
 */
SettingsSearch.removeResources(...resources: Resource[]);

/**
 * Remove all resources associated with a particular SettingTab id.
 */
SettingsSearch.removeTabResources(id: string)
```

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

### Configure Statblock Source

Source: https://plugins.javalent.com/statblocks/readme/code-block

Specifies the 'bestiary' where the statblock should be placed. Changing the source after initial creation requires an Obsidian reload or restart for the codeblock data to update. This ensures proper organization and retrieval of statblocks.

```statblock
# This is like.. config!
dice: true
render: true
layout: Basic Pathfinder 2e Layout
columns: 2
forceColumns: true
columnHeight: 750px
columnWidth: 550px
source: "Pie"


# Statblock Starts
name: "Shápsín"

```

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

### Settings Search Plugin Metadata

Source: https://plugins.javalent.com/settings-search

Metadata for the Settings Search plugin, including aliases, description, permalink, publish status, and tags. This information is used for organization and discoverability within Obsidian.

```yaml
aliases: [Obsidian Settings Search, Settings Search API, Settings Search]
description: Settings Search adds a global search to Obsidian's settings
permalink: settings-search
publish: true
tags: [Settings-Search, API/Settings-Search]
```

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

### Configure Statblock Column Width

Source: https://plugins.javalent.com/statblocks/readme/code-block

Sets the width for each column within a statblock. This is an integer value that can include sizing parameters like px, em, or vh. Adjusting column width helps manage the overall dimensions of the statblock, especially on wider screens.

```statblock
# This is like.. config!
dice: true
render: true
layout: Basic Pathfinder 2e Layout
columns: 2
forceColumns: true
columnHeight: 750px
columnWidth: 550px

# Statblock Starts
name: "Shápsín"

```

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

### Enable 3D Dice Rendering in Statblocks

Source: https://plugins.javalent.com/statblocks/readme/code-block

This snippet illustrates how to enable the rendering of 3D dice within Fantasy Statblocks. Setting `render: true` alongside `dice: true` will display dice rollers as 3D dice on the screen, provided the "Render Dice Rolls" setting is enabled in the plugin's settings or the `render: true` parameter is included in the statblock code.

```markdown
```statblock
# This is like.. config!
dice: true
render: true
layout: Basic Pathfinder 2e Layout

# Statblock Starts
name: "Shápsín"
```
```
Tokens:
Raw