Compare commits

..

No commits in common. "master" and "0.0.2" have entirely different histories.

5 changed files with 45 additions and 77 deletions

21
LICENSE
View file

@ -1,21 +0,0 @@
MIT License
Copyright (c) 2023 Erica Xu
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View file

@ -6,37 +6,29 @@ Not sure if an AI assistant is going to be helpful in your workflow?
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:
Introducing Obsidian's first assistant - Gemmy, the Obsidian Unhelper. It has two major features:
## Randomly saying things
Gemmy seeks validation by randomly saying things every now and then.
Gemmy seeks validation by saying randomly things every now and then.
You can customize how often this happens. Or just don't summon Gemmy.
## 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 pops out to [motivate you](https://user-images.githubusercontent.com/1171143/229297494-8a0cae3f-4c8e-47a9-801b-dd1c52dfc917.png) when you have stop typing for long enough. Again you can customize how long that would be.
Risk: Gemmy might actually be helpful with writing if you use this mode. We're not responsible for any extra productivity Gemmy might bring.
Risk: Gemmy might actually be helpful with writing if you use this mode. We're not responsibility for any extra productivity Gemmy brings.
## How to use
Install Gemmy. There are four commands in the command palette when you type "Gemmy". You can figure out the rest on your own.
Install Gemmy. There are four commands in command palette when you type "Gemmy". You can figure out the rest on your own.
---
Special thanks: [Rigmarole](https://rigmarolestudio.com/) for creating and animating Gemmy
Credit: the talented Obsidian mods team, including argentum, CawlinTeffid, cotmax, Eleanor Konik, koala, Leah, rigmarole, ryanjamurphy & WhiteNoise
The code is under MIT license, whereas the Gemmy character is under CC BY 3.0 license.
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)
Credit: the talented Obsidian mods team, including argentum, CawlinTeffid, cotmax, Eleanor Koink, koala, Leah, rigmarole, ryanjamurphy & WhiteNoise
---

68
main.ts
View file

@ -7,16 +7,18 @@ import LOOK_MOTION from './animations/gemmy_lookAround.gif'
import IDLE_MOTION from './animations/gemmy_idle.gif'
import DISAPPOINT_IMG from './animations/gemmy_disappoint.gif'
// Remember to rename these classes and interfaces!
interface GemmySettings {
// how often does Gemmy talk in idle mode, in minutes
idleTalkFrequency: number;
// the number of minutes you must write before Gemmy appears to mock you
writingModeGracePeriod: number;
writingModeDeadline: number;
}
const DEFAULT_SETTINGS: GemmySettings = {
idleTalkFrequency: 5,
writingModeGracePeriod: 5
writingModeDeadline: 5
};
@ -26,29 +28,27 @@ const GEMMY_IDLE_QUOTES = [
"You have plugins that you can update!",
"Hi I'm Gemmy! Like Clippy but shinier!",
"Everything is connected. Everything.",
"Cant decide which note to work on? Try the Random Note core plugin!",
"Are you sure you dont want to upload all your notes just so we can chat?",
"How tall would all your notes be if you stacked them up?",
"Wanna teach me to say things? Find me on GitHub and open a pull request!",
"Have you considered using Comic Sans?",
"A blank page is just a masterpiece in waiting"
`It looks like youre writing a note.,
Would you like help?
- Get help with writing the note
- Just type the note without help
- [ ] Dont show me this tip again`,
'Cant decide which note to work on? Try the Random Note core plugin!',
'Are you sure you dont want to upload all your notes just so we can chat?',
'How tall would all your notes be if you stacked them up?',
'Wanna teach me to say things? Find me on GitHub and open a pull request!',
'Have you considered using Comic Sans?'
];
const WRITING_MODE_QUOTES = [
"Is that the best you can do? Keep writing!",
"Write first, edit later.",
"I love hearing your keyboard. Don't stop.",
"How about we review some old notes today?",
"Stuck? Try journaling what happened today and see if that gives you inspiration.",
"Maybe it's time to go get some water or coffee.",
"Anything is better than a blank page, even me. Write something!",
"Oh, taking a break? Dont let the ideas get cold!",
"Whats this? Writers block already?",
"Youve got this! Every keystroke is a step closer to brilliance.",
"Youre doing amazing! Keep the momentum going.",
"Bold choice to open Obsidian and then do absolutely nothing.",
"Is this a journal or a staring contest with the cursor?",
"Hmm, I didnt realize staring at the screen was a new note-taking strategy."
`Is that the best you can do? Keep writing!`,
`Write first, editor later.`,
`I love hearing your keyboard. Don't stop.`,
`How about we review some old notes today?`,
`Stuck? Try journaling what happened today and see if that gives you inspiration.`,
`Maybe it's time to go get some water or coffee.`,
`Anything is better than a blank page, even me. Write something!`
];
const BUBBLE_DURATION = 5000;
@ -70,7 +70,7 @@ export default class Gemmy extends Plugin {
gemmyEl.setAttribute('aria-label-delay', '0');
gemmyEl.setAttribute('aria-label-classes', 'gemmy-tooltip');
this.imageEl = gemmyEl.createEl('img', {});
let gemmyImageEl = this.imageEl = gemmyEl.createEl('img', {});
this.addCommand({
id: 'show',
@ -136,8 +136,6 @@ export default class Gemmy extends Plugin {
this.disappear();
this.setWritingModeTimeout();
}, 500)));
app.workspace.onLayoutReady(this.appear.bind(this));
}
appear() {
@ -145,14 +143,18 @@ export default class Gemmy extends Plugin {
imageEl.setAttribute('src', EMERGE_MOTION);
// Quicker if we're in writing mode
// Quick if we're in writing mode
if (this.inWritingMode) {
imageEl.setAttribute('src', POP_MOTION);
setTimeout(() => {
// imageEl.setAttribute('src', DISAPPOINT_IMG);
// setTimeout(() => {
// imageEl.setAttribute('src', DISAPPOINT_IMG);
this.appeared = true;
this.saySomething(WRITING_MODE_QUOTES, true);
// }, 1000);
}, 1800);
}
else {
@ -183,6 +185,7 @@ export default class Gemmy extends Plugin {
}
enterWritingMode() {
let { gemmyEl } = this;
this.inWritingMode = true;
this.disappear();
@ -208,7 +211,7 @@ export default class Gemmy extends Plugin {
}
this.appear();
}, this.settings.writingModeGracePeriod * 1000);
}, this.settings.writingModeDeadline * 60000);
}
startNextIdleTimeout() {
@ -261,7 +264,7 @@ export default class Gemmy extends Plugin {
}
onunload() {
this.disappear();
}
async loadSettings() {
@ -273,6 +276,7 @@ export default class Gemmy extends Plugin {
}
}
// TODO: proper setting tab
class GemmySettingTab extends PluginSettingTab {
plugin: Gemmy;
@ -300,13 +304,13 @@ class GemmySettingTab extends PluginSettingTab {
new Setting(containerEl)
.setName('Writing mode grace period')
.setDesc('How soon Gemmy starts to get disappointed after you stop tying in writing mode, in seconds.')
.setDesc('How soon Gemmy starts to get disappointed after you stop tying in writing mode, in minutes.')
.addSlider(slider => slider
.setLimits(5, 180, 5)
.setLimits(5, 60, 5)
.setDynamicTooltip()
.setValue(this.plugin.settings.writingModeGracePeriod)
.setValue(this.plugin.settings.writingModeDeadline)
.onChange(async (value) => {
this.plugin.settings.writingModeGracePeriod = value;
this.plugin.settings.writingModeDeadline = value;
await this.plugin.saveSettings();
}));
}

View file

@ -1,7 +1,7 @@
{
"id": "gemmy",
"name": "Gemmy",
"version": "1.0.1",
"version": "0.0.2",
"minAppVersion": "0.15.0",
"description": "2023 April Fool's plugin brought to you by Obsidian",
"author": "Obsidian",

View file

@ -15,9 +15,6 @@ If your plugin does not need CSS, delete this file.
position: fixed;
bottom: 30px;
right: 30px;
display: flex;
flex-direction: column;
align-items: flex-end;
}
.gemmy-container img {
@ -26,14 +23,10 @@ If your plugin does not need CSS, delete this file.
border-radius: var(--gemmy-size);
}
.gemmy-container[aria-label]::before {
.gemmy-tooltip {
--background-modifier-message: #FFFFCB;
content: attr(aria-label);
color: #202020;
font-size: var(--font-ui-medium);
border-radius: 20px;
padding: var(--size-4-3) var(--size-4-6);
width: 150px;
background: var(--background-modifier-message);
}
}