https://github.com/maadhattah/obsidian-poker

Easily document and view your poker hands.
https://github.com/maadhattah/obsidian-poker

holdem obsidian obsidian-plugin poker

Last synced: about 2 months ago
JSON representation

Easily document and view your poker hands.

• Host: GitHub
• URL: https://github.com/maadhattah/obsidian-poker
• Owner: mAAdhaTTah
• License: mit
• Created: 2023-06-21T21:57:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-27T16:11:56.000Z (about 2 months ago)
• Last Synced: 2024-10-27T18:54:05.815Z (about 2 months ago)
• Topics: holdem, obsidian, obsidian-plugin, poker
• Language: TypeScript
• Homepage:
• Size: 314 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Obsidian Poker

Easily document and view your poker hands.

## Screenshot

![Rendered Cards](rendered-editor.png)

## How to Install

In Obsidian go to `Settings > Third-party plugins > Community Plugins > Browse` and search for `Poker`.

### Manual installation

Unzip the [latest release](https://github.com/mAAdhaTTah/obsidian-poker/releases/latest) into your `/.obsidian/plugins/` folder.

## How to Configure

The plugin allows you to customize the prefix you use for inline cards. Go to `Settings -> Poker` to customize. The plugin defaults to `pkr` as the prefix.

## How to Use

### Rendering Cards

To render a card, add backticks your chosen prefix, and a colon, then write the card(s) in standard 2 letter notation, with a rank & suit pair. Ranks should be one of `AKQJT98765432X` (with X being rendered as `X` and meaning "any rank"); suits should be one of `dhscx` (with X being rendered as `x` and meaning "any suit").

#### Example

```

This is a card: `pkr:As`.

You can also do multiple cards at once: `pkr:AsAc`.

```

## Roadmap

- Add support for card with no suit (e.g. `Kx`)

- Add support for unknown suited or offsuit cards or other cards (e.g. `KsXo`, `KsXs`, or `KsX`)

- Add command to generate a random number of cards (e.g. to generate a random flop)

- Add a hand replayer using markdown codeblocks & YAML to define a hand and show a replayer in preview to watch it