obsidian-plugin/ericaxu_gemmy
1
0
Fork 0
mirror of https://github.com/ericaxu/gemmy.git synced 2026-07-22 07:30:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Signed-off-by: Rebbecca Bishop <Scholarlysigrun@icloud.com>
This commit is contained in:
Rebbecca Bishop 2023-08-10 22:00:25 -05:00 committed by GitHub
parent 148eee822d
commit cc1c66599f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,30 +1,29 @@
# Gemmy for TTRPG's—The Obsidian Unhelper, Unshackled.
# Granite, the Goal Reinforcing And Note Improving Tiny Entity
Presenting an alternate reality version of Gemmy for TTRPGs, because who needs a nice and helpful AI assistant in their workflow, right?
Inspired by the saintly [Gemmy](https://github.com/ericaxu/gemmy), the Obsidian TTRPG Community has taken Gemmy on an adventure through time and space. She's met dragons, owlbears, robots, aliens, and so many interesting beings. Many of them have have decided to join her on the quest for the most sarcastic, the most scathing, and sometimes, the most helpful reactions to
Oh, don't fret; we've taken care of all the uncertainties for you. Gemmy for TTRPG is guaranteed to be 100% snarky, unhelpful, and... well, let's just say it excels at saying all the things you _wish_ you could say to your players or game mediator.
## Features
Our _sometimes homicidal_ Gemmy has two major features:
### Multiple Characters
- Gemmy, the original [Obsidian](https://www.obsidian.md/) Shard whom has all new quotes.
- Granite, Gemmy's rival in all things unhelpful. She'll not stop until that purple shard succumbs to the power of her words. (:sparkles: Coming Soon)
- Drake, the dashing and devious dragon who loves mothing more than to talk about dice. (:sparkles: Coming Soon)
## Randomly saying things
### Random Quotes
Get ready to encounter the awe-inspiring Gemmy, unshackled and free! Gemmy for TTRPGs is a sassy and charismatic character who joyfully guides you through the vast world of TTRPGs, showering you with enlightening insights and knowledge. Gemmy finds comfort in your never-ending journey of learning and shares their wisdom with you. Granted, her wisdom is often a bit... unconventional, but it's the thought that counts, right?
Like the original Gemmy, this plugin is based around your "animated pet rock" talking to you, and so it does this on an interval of your choosing within Granite's settings. Sometimes they whisper words of encouragement, and other times they laugh at your writer's block.
Should you desire, feel free to personalize the frequency of these enlightening encounters.
> :sparkles: **Coming Soon**: Individualized Quotes per Character
Alternatively, you can always opt for the wise choice of not summoning Gemmy at all.
### Writing mode
The decision is yours to make, brave writer.
Granite emerges to graciously disrupt your peaceful writing sessions by helpfully pointing out whenever you've dared to pause for an extended duration—because who needs uninterrupted focus, am I right?
## Writing mode
Gemmy Unshackled emerges to graciously disrupt your peaceful writing sessions by helpfully pointing out whenever you've dared to pause for an extended duration—because who needs uninterrupted focus, am I right?
By some bizarre twist of fate, using this mode might actually infuse Gemmy Unshackled with a rare burst of motivation, urging you to write with unexpected zeal. Please be aware that we cannot be held accountable for any unforeseen surge in productivity that Gemmy Unshackled may accidentally induce. Best of luck to your tabletop roleplaying and writing adventures.
By some bizarre twist of fate, using this mode might actually infuse Granite with a rare burst of motivation, urging you to write with unexpected zeal. Please be aware that we cannot be held accountable for any unforeseen surge in productivity that Granite may accidentally induce. Best of luck to your tabletop roleplaying and writing adventures.
## How to Install and Use
To avoid any potential issues, it is advisable not to utilize the Gemmy for TTRPG plugin for work vaults, given its particular language characteristics. It might also roast your coworkers.
To avoid any potential issues, it is advisable not to utilize Granite plugin for work vaults, given its particular language characteristics. It might also roast your coworkers.
It is also not recommended you use this on top of the original Gemmy plugin, as it will cause a conflict.
@ -36,13 +35,13 @@ Coming Soon to the Obsidian Community Store.
### Manual Installation
1. Download the latest Gemmy for TTRPGss release from this Repository.
1. Download the latest Granite release from this Repository.
2. Unzip the release into your `.obsidian/plugins` folder.
3. Enable the plugin within Obsidian.
### Command Palette
There are four commands in the Obsidian [command palette](https://help.obsidian.md/Plugins/Command+palette) when you type “Gemmy”.
There are four commands in the Obsidian [command palette](https://help.obsidian.md/Plugins/Command+palette) when you type “Granite”.
You can figure out the rest on your own… if you roll the right number on the die.
@ -58,6 +57,4 @@ The code is code for Original Gemmy is licensed under the [MIT license](https://
The pre-sharded Obsidian Logo is adapted from:
[Crystal shard icon](https://icon-icons.com/icon/Crystal-Shard/88819) By [Chanut is Industries](https://icon-icons.com/users/W52nHhY3W1VlvwyJTwS4d/icon-sets/)
Draconic Gemmy was created by [Behalter](https://github.com/Behalter) and adapted from Obsidian's https://obsidian.md/brand
**License**: Attribution 3.0 Unported (CC BY 3.0)