GithubHelp home page GithubHelp logo

modality / obsidian-the-one-ring-2e-statblocks Goto Github PK

View Code? Open in Web Editor NEW
9.0 4.0 2.0 21 KB

An Obsidian plugin to render stat blocks for The One Ring, Second Edition.

License: MIT License

JavaScript 8.59% TypeScript 64.26% CSS 27.15%

obsidian-the-one-ring-2e-statblocks's Introduction

The One Ring 2E Statblocks

This plugin renders adversary statblocks for The One Ring, Second Edition.

Many thanks to @ben for creating the 13th Age statblocks plugin from which this plugin is adapted.

Thanks to @vehrka for their styling contributions.

Development

  • Clone this repo.
  • npm i or yarn to install dependencies
  • npm run dev to start compilation in watch mode.

Manually installing the plugin

  • Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/tor2e-statblocks/.
    • If you ran npm run dev, these will be in the root folder.
    • Pre-built versions of these files can be found in the releases.
  • In Obsidian, navigate to Preferences > Community plugins. Toggle The One Ring 2E Statblocks on.

Create a statblock

A statblock may be defined in a note using this syntax. Fields are mostly optional. If the stat block "disappears" it is because there is a field in the wrong format. Try adding fields one at a time.

The parameters in the statblock are parsed as YAML. Certain Obsidian conventions (for example, double brackets: [[]]) may not work as YAML has its own interpretation of what this means. Try wrapping these in double quotes "".

Fields

  • name - Adversary name
  • blurb or description - The flavor-text description about the adversary.
    • This field is rendered as Markdown: Obsidian links [[]] will work here.
  • features - A list of distinctive features
  • level - The attribute level of the adversary
  • endurance - Endurance points
  • might - Might rating
  • hate or resolve - Use either of these, the right label will appear
  • parry - Parry rating
  • armour or armor - Armour rating
  • proficiencies - Combat proficiencies. These are represented by a list of YAML dictionaries in the following format:
    • name - The attack name
    • rating - The attack rating
    • damage - The damage rating
    • injury - The injury threshold
    • special - Special damage opportunities
      • This field is rendered as Markdown: Obsidian links [[]] will work here. If they are not rendering as links, try wrapping the brackets in double quotes.
  • abilities - A list of Fell Abilities
    • This field is rendered as Markdown: Obsidian links [[]] will work here. If they are not rendering as links, try wrapping the brackets in double quotes.

Example

```tor2e
name: The Covetous Lurker
description: The Covetous Lurker is a worm-like creature that lives underground. It has great grasping claws which clash against cave walls as it pulls itself around its territory, searching for invaders which seek to steal its treasure.
features:
- Greedy
level: 7
endurance: 70
might: 2
hate: 7 # or resolve
parry: 0
armour: 3 # or armor
proficiencies:
- name: Rend
  rating: 3
  damage: 5
  injury: 16
  special: "[[Special Damage Options#Seize|Seize]]"
- name: Crush
  rating: 3
  damage: 7
  injury: 12
  special: "[[Special Damage Options#Break Shield|Break Shield]]"
abilities:
- "[[Fell Abilities#Fear of Fire|Fear of Fire]]"
- "[[Fell Abilities#Thing of Terror|Thing of Terror]]"
- "[[Fell Abilities#Thick Hide|Thick Hide]]"
```

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.