/obsidian-13th-age-glorantha-statblocks

Obsidian plugin to render 13th Age-style Glorantha stat blocks

Primary LanguageTypeScriptMIT LicenseMIT

13th Age Statblocks

This plugin renders 13th-Age plugins, and includes SRD content to base your monsters from.

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/13th-age-statblocks/.

Improve code quality with eslint (optional)

  • ESLint is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
  • To use eslint with this project, make sure to install eslint from terminal:
    • npm install -g eslint
  • To use eslint to analyze this project use this command:
    • eslint main.ts
    • eslint will then create a report with suggestions for code improvement by file and line number.
  • If your source code is in a folder, such as src, you can use eslint with this command to analyze all files in that folder:
    • eslint .\src\

API Documentation

See https://github.com/obsidianmd/obsidian-api