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

✨🔧 UTF-8: Update README.md formatting and Gemmy description

Browse source
This commit is contained in:
Sigrunixia 2023-05-21 00:04:58 -05:00
parent e2149a99d5
commit 5e0a9dd9b2
No known key found for this signature in database
GPG key ID: B6B8AAFE8ABC62D2
1 changed files with 28 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -1,45 +1,50 @@
# Gemmy - Obsidian Unhelper
# Gemmy for TTRPG's—The Obsidian Unhelper, Unshackled.
<img src="https://user-images.githubusercontent.com/1171143/229297707-5efa8761-ef55-4d01-a105-88a347bc6cf0.png" width="300">
Presenting an alternate reality version of Gemmy for TTRPGs, because who needs a nice and helpful AI assistant in their workflow, right?
Not sure if an AI assistant is going to be helpful in your workflow?
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.
Don't worry, we've eliminated the guesswork for you because Gemmy is 100% going to be unhelpful.
Introducing Obsidian's first assistant — Gemmy, the Obsidian Unhelper. It has two major features:
Our _sometimes homicidal_ Gemmy has two major features:
## Randomly saying things
Gemmy seeks validation by randomly saying things every now and then.
Prepare yourself for the magnificent presence of Gemmy Unshackled, who takes it upon themselves to enlighten you about the vast expanse of knowledge you have yet to develop in the realm of TTRPGs—simply because Gemmy Unshackled finds solace in your perpetual state of learning.
You can customize how often this happens. Or just don't summon Gemmy.
Should you desire, feel free to personalize the frequency of these enlightening encounters.
Alternatively, you can always opt for the wise choice of not summoning Gemmy at all.
The decision is yours to make, brave writer.
## Writing mode
Gemmy pops out to [motivate you](https://user-images.githubusercontent.com/1171143/229297494-8a0cae3f-4c8e-47a9-801b-dd1c52dfc917.png) when you have stopped typing for long enough. Again, you can customize how long that should be.
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?
Risk: Gemmy might actually be helpful with writing if you use this mode. We're not responsible for any extra productivity Gemmy might bring.
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.
## How to use
## How to Install and Use
Install Gemmy. There are four commands in the command palette when you type "Gemmy". You can figure out the rest on your own.
> To avoid any potential issues, it is advisable not to utilize the Gemmy Unshackled plugin for work vaults, given its particular language characteristics. It might roast your coworkers.
---
1. Download the latest Gemmy Unshackled release from this Repository.
2. Unzip the release into your `.obsidian/plugins` folder.
3. Enable plugin within Obsidian.
Special thanks: [Rigmarole](https://rigmarolestudio.com/) for creating and animating Gemmy
### Command Palette
Credit: the talented Obsidian mods team, including argentum, CawlinTeffid, cotmax, Eleanor Konik, koala, Leah, rigmarole, ryanjamurphy & WhiteNoise
There are four commands in the Obsidian [command palette](https://help.obsidian.md/Plugins/Command+palette) when you type "Gemmy".
The code is under MIT license, whereas the Gemmy character is under CC BY 3.0 license.
You can figure out the rest on your own… if you roll the right number on the die.
## Legal Disclaimers
The Obsidian Team released original Gemmy April 1st, 2023.
Credits for the Original, saintly [Gemmy](https://github.com/ericaxu/gemmy) go to @ericaxu. With special thanks to [Rigmarole](https://rigmarolestudio.com/) for creating and animating the original Gemmy. Additional Credit is given to the talented Obsidian mods team, including argentum, CawlinTeffid, cotmax, Eleanor Konik, koala, Leah, rigmarole, ryanjamurphy & WhiteNoise.
The code is code for Original Gemmy is licensed under the [MIT license](https://mit-license.org), whereas the Gemmy character is under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) license. The Obsidian TTRPG Community will extend Gemmy-TTRPG under the MIT License for code, and CC BY 3.0 license for the character and any alterations respectively.
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/)
License: Attribution 3.0 Unported (CC BY 3.0)
---
## Happy April Fools'
Gemmy was proudly released on April 1, 2023.