joplin-plugin-lootboxes 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Lootboxes
|
|
2
|
+
|
|
3
|
+
This [Joplin](https://joplinapp.org/) plugin provides a 'gamification' element for users who use to-do notes to track completion of tasks.
|
|
4
|
+
|
|
5
|
+
This app relies on Joplin's inherent synchronization capabilities to maintain the user's earned inventory state and lootbox progress across devices. Joplin's media caching also allows the user to easily access and view the multiple media files of their earned lootboxes.
|
|
6
|
+
|
|
7
|
+
<img src="examples/open.png">
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- Modify the number of to-do notes to complete in order to earn a lootbox within the plugin settings menu. To-do notes will automatically be converted when the lootbox panel is opened, and when a synchronization event is completed.
|
|
12
|
+
|
|
13
|
+
- Customize the UI behavior on startup with the checkboxes in the plugin settings menu.
|
|
14
|
+
|
|
15
|
+
- Configure a custom keyboard shortcut to toggle the lootbox panel in the Joplin settings. By default this is `ctrl+3`
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
## Known Issues
|
|
19
|
+
- When a media element is clicked on and expanded into the magnified dialog view, if the user moves their cursor out of the dialog bounds and presses `esc` twice to close the dialog, the dialog will disappear but the Joplin application will freeze as if there is still a dialog covering the screen. This is avoided for now by clicking the 'close' button to exit from the dialog.
|
|
20
|
+
|
|
21
|
+
## Todo:
|
|
22
|
+
- add more sorting and view options for earned lootboxes
|
|
23
|
+
- enable functionality to specify subset of notebooks which are allowed to earn lootboxes, letting other sections function as normal
|
|
24
|
+
- see if plugin can work well on mobile
|
|
25
|
+
- investigate video element loading behavior
|
|
26
|
+
- looks like Joplin implements native media caching that plays well with the content displayed in the lootbox panel. However, the video elements are often loaded as the blank media fallback element, only loading in when the mouseenter event is triggered...
|
|
27
|
+
- perhaps the video preloading logic can be adjusted, or the caching logic can be adjusted to have these elements load in more smoothly.
|
|
28
|
+
- investigate why clicking out of the big dialog and pressing esc twice causes the application to freeze
|
|
29
|
+
- add more lootboxes
|
|
30
|
+
- determine if it's beneficial to add an optional caching setting for 'all lootboxes' so new lootboxes can be earned offline
|
|
31
|
+
- clean up the `verboseLogs` value in util.ts; make log messages more consistent in general
|
|
32
|
+
|
|
33
|
+
suggestions and feedback are welcome!
|
package/package.json
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "joplin-plugin-lootboxes",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"scripts": {
|
|
5
|
+
"dist": "webpack --env joplin-plugin-config=buildMain && webpack --env joplin-plugin-config=buildExtraScripts && webpack --env joplin-plugin-config=createArchive",
|
|
6
|
+
"prepare": "npm run dist",
|
|
7
|
+
"updateVersion": "webpack --env joplin-plugin-config=updateVersion",
|
|
8
|
+
"update": "npm install -g generator-joplin && yo joplin --node-package-manager npm --update --force"
|
|
9
|
+
},
|
|
10
|
+
"license": "MIT",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"joplin-plugin"
|
|
13
|
+
],
|
|
14
|
+
"files": [
|
|
15
|
+
"publish"
|
|
16
|
+
],
|
|
17
|
+
"devDependencies": {
|
|
18
|
+
"@types/node": "^18.7.13",
|
|
19
|
+
"chalk": "^4.1.0",
|
|
20
|
+
"copy-webpack-plugin": "^11.0.0",
|
|
21
|
+
"fs-extra": "^10.1.0",
|
|
22
|
+
"glob": "^8.0.3",
|
|
23
|
+
"tar": "^6.1.11",
|
|
24
|
+
"ts-loader": "^9.3.1",
|
|
25
|
+
"typescript": "^4.8.2",
|
|
26
|
+
"webpack": "^5.74.0",
|
|
27
|
+
"webpack-cli": "^4.10.0"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
Binary file
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"manifest_version": 1,
|
|
3
|
+
"id": "joplin-plugin-lootboxes",
|
|
4
|
+
"app_min_version": "3.5",
|
|
5
|
+
"version": "1.0.0",
|
|
6
|
+
"name": "Lootboxes",
|
|
7
|
+
"description": "Accumulate lootboxes while completing todo notes",
|
|
8
|
+
"author": "Haotian Zeng",
|
|
9
|
+
"homepage_url": "",
|
|
10
|
+
"repository_url": "https://github.com/A-440Hz/joplin-plugin-lootboxes.git",
|
|
11
|
+
"keywords": [
|
|
12
|
+
"lootbox",
|
|
13
|
+
"lootboxes",
|
|
14
|
+
"todo"
|
|
15
|
+
],
|
|
16
|
+
"categories": [
|
|
17
|
+
"appearance",
|
|
18
|
+
"productivity"
|
|
19
|
+
],
|
|
20
|
+
"screenshots": [
|
|
21
|
+
{
|
|
22
|
+
"src": "examples/open.png",
|
|
23
|
+
"label": "An example of opening a lootbox in this plugin."
|
|
24
|
+
}
|
|
25
|
+
],
|
|
26
|
+
"icons": {
|
|
27
|
+
"16": "icons/16.png",
|
|
28
|
+
"32": "icons/32.png"
|
|
29
|
+
},
|
|
30
|
+
"promo_tile": {},
|
|
31
|
+
"_publish_hash": "sha256:c6cc83c8838b0d534fcddf904c5fcf0cca08471d6823386f65e987b05e1de0be",
|
|
32
|
+
"_publish_commit": "main:02f51bf24d01fbf84b875c0bf21240c645eab842"
|
|
33
|
+
}
|