docs: about usage

tiddly-gittly · Mar 25, 2024 · f700588 · f700588
1 parent 1f4dee1
commit f700588
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/wiki/tiddlers/language/en-GB/RealityEvents.tid b/wiki/tiddlers/language/en-GB/RealityEvents.tid
@@ -1,8 +1,8 @@
 title: language/en-GB/RealityEvents
 
-!!! Reality Event Cache
+!! Reality Event Cache
 
-Reality Event cache Tiddlers are tiddlers tagged with {{$:/plugins/linonetwo/tw-gamification/tags/reality-event-cache-meta-tag}}, they store Event data of type [[TypesOfRealityEvents]] as JSON lists.
+Reality Event cache Tiddlers are tiddlers tagged with {{$:/plugins/linonetwo/tw-gamification/tags/reality-event-cache-meta-tag}}, they store Event data of type [[TypesOfRealityEvents]] as JSON lists. These files are used to store reality events waiting to be converted by the game into in-game rewards.
 
 For example,
 
@@ -37,3 +37,13 @@ The TypeScript types are detailed in `src/tw-gamification/reality-event-generato
   }
 ]
 ```
+
+!! Reality Action
+
+Tiddlers with <$macrocall $name="tag" tag={{$:/plugins/linonetwo/tw-gamification/tags/reality-action-meta-tag}} /> tags and satisfying the `EventGeneratorDefinitions` type tiddlers are recognized as `Reality Actions`, which means actions completed in real life.
+
+!!! Realistic Action Log
+
+Realistic actions can be represented as buttons, like in [[$:/plugins/linonetwo/ego-store-lite]]. In this plugin, for buttons that are clicked, activity are logged in to a tiddler, making it possible to visualize the number of times each action is completed each week.
+
+The format of the reality action log needs to fulfill the description in the [[$:/plugins/linonetwo/activity-log-tools]] plugin.
diff --git a/wiki/tiddlers/language/zh-Hans/RealityEvents.tid b/wiki/tiddlers/language/zh-Hans/RealityEvents.tid
@@ -2,7 +2,7 @@ title: language/zh-Hans/RealityEvents
 
 !! 现实事件数据缓存
 
-「现实事件数据条目」即加了 {{$:/plugins/linonetwo/tw-gamification/tags/reality-event-cache-meta-tag}} 标签的条目，在里面用 JSON 列表的形式保存了类型为[[现实事件的类型|TypesOfRealityEvents]]的事件数据。
+「现实事件数据缓存条目」即加了 {{$:/plugins/linonetwo/tw-gamification/tags/reality-event-cache-meta-tag}} 标签的条目，在里面用 JSON 列表的形式保存了类型为[[现实事件的类型|TypesOfRealityEvents]]的事件数据。这些文件用于存储等待被游戏转换为游戏内奖励的现实事件。
 
 例如：
 
@@ -37,3 +37,13 @@ title: language/zh-Hans/RealityEvents
   }
 ]
 ```
+
+!! 现实行动
+
+带有 <$macrocall $name="tag" tag={{$:/plugins/linonetwo/tw-gamification/tags/reality-action-meta-tag}} /> 标签并满足 `EventGeneratorDefinitions` 类型的条目会被识别为「现实行动」，即现实生活中完成的行动。
+
+!!! 现实行动记录
+
+现实行动可以表示为按钮，参考 [[$:/plugins/linonetwo/ego-store-lite]]。在这个插件中，被点击的按钮会记录「现实行动记录」条目，从而可以可视化每周完成每个行动的次数。
+
+现实行动记录的格式需要满足 [[$:/plugins/linonetwo/activity-log-tools]] 插件中的描述。