Obsidian Pal is a special project for the "2025 Summer Steam Challenge," sponsored by the Bright Future Talent Hub & CityU.
Obsidian Pal系個為「2025 Summer STEAM Challenge」而設嘅特別項目，由 Bright Future Talent Hub 及香港城市大學聯合贊助。
Welcome! Obsidian Pal is more than just a plugin; it's a powerful, free, and personalized AI assistant designed specifically to support Hong Kong secondary school students on their learning journey. Built with the HKDSE curriculum in mind, it integrates directly into your Obsidian vault to become your ultimate study partner.
歡迎！Obsidian Pal 唔單止係一個插件；佢係一個強大、免費、而且個人化嘅 AI 助手，專為香港中學生嘅學習旅程而設計。我哋以 HKDSE 課程為基礎，將佢直接整合到你嘅 Obsidian vault，成為你嘅終極學習夥伴。
Our mission is to provide an accessible, supportive, and intelligent tool that helps you learn smarter, stay organized, and manage the pressures of student life. 我哋嘅使命係提供一個易用、有支援性又夠智能嘅工具，幫你學得更聰明、保持條理，同埋應對學生生活嘅壓力。
Obsidian Pal is packed with features designed to address every aspect of your study routine.
Obsidian Pal 滿載各種功能，旨在滿足你溫習日常嘅每一個方面。
Choose the right tool for the right moment from our intuitive home screen:
喺我哋清晰嘅主頁面，為唔同嘅需要選擇最適合嘅工具：
-
🧑🏫 Teach Me: Your personal AI tutor. Ask it to explain any concept from your subjects. It can even read your own notes in your vault to give you explanations tailored to what you've already learned!
-
🧑🏫 Teach Me： 你嘅私人 AI 導師。問佢任何學科嘅概念，佢都會為你解釋。佢甚至可以讀取你 vault 入面嘅筆記，提供完全貼合你已有知識嘅解釋！
-
📝 Quiz Me: Test your knowledge with HKDSE-style quizzes.
-
📝 QUiz Me： 用 HKDSE 風格嘅測驗嚟測試你嘅知識。
- Generates MCQs, short answer, and true/false questions.
- 自動生成選擇題、短答題和是非題。
- Special modes for Chinese & English Languages, including Reading Comprehension (閱讀理解) and Writing Prompts (作文).
- 為中、英文科特設特別模式，包括閱讀理解及作文題目。
- Choose your difficulty level (Low, Medium, High).
- 選擇你嘅難度級別（低、中、高）。
-
🎯 Automatic Weakness Tracker: This is where the magic happens! When you get a question wrong in a quiz, Obsidian Pal automatically logs the concept or exam technique you struggled with. Over time, it builds a clear picture of where you need to focus your revision.
-
🎯 自動弱點追蹤器： 呢個就係神奇之處！當你喺測驗答錯問題時，Obsidian Pal 會自動記錄你唔熟嘅概念或考試技巧。慢慢咁，佢就會清晰咁展示出你需要重點溫習嘅地方。
-
🗓️ Plan My Study: Feeling overwhelmed? Tell Pal what you're studying for, and it will generate a day-by-day study schedule, prioritizing the topics from your Weakness Tracker.
-
🗓️ 規劃我嘅溫習： 覺得好大壓力？話俾 Pal 知你溫緊咩，佢就會為你制定一個每日溫習時間表，仲會優先處理你弱點追蹤器入面嘅項目。
-
💬 Emotion Support: Student life can be tough. This mode provides a friendly, non-judgmental, and empathetic space for you to talk about your feelings. It's a friend who's always there to listen.
-
💬 情緒支援： 學生生活有時真係唔容易。呢個模式提供一個友善、唔會批判、充滿同理心嘅空間，俾你傾訴你嘅感受。佢係一個隨時準備好聽你講嘢嘅朋友。
-
Reads Your Notes (Reterival-Augmented Generation): When you ask a question in "Teach Me" or "Quiz Me" mode, Pal intelligently searches your vault for relevant notes, using them as context to provide answers that are perfectly aligned with your study materials.
-
讀取你嘅筆記 (Reterival-Augmented Generation)： 當你喺「教我知識」或「測驗我」模式問問題時，Pal 會聰明咁喺你嘅 vault 搜尋相關筆記，並用佢哋作為背景資料，提供完全貼合你溫習材料嘅答案。
-
Focus on Weaknesses: In Quiz mode, you can toggle a "Focus on Weaknesses" button to get questions that specifically target the areas you need to improve, based on your tracker.
-
專注於弱點： 喺測驗模式，你可以開啟「專注於弱點」按鈕，Pal 就會根據你嘅追蹤器，專門出啲針對你需要改進地方嘅問題。
We believe in inclusivity. Pal is designed to communicate with you in the language you're most comfortable with. Full support for: 我哋相信共融嘅重要性。Pal 嘅設計可以同你用最舒服嘅語言溝通。全面支援：
- Cantonese (Traditional Chinese) / 廣東話（繁體中文）
- English (US & British) / 英文（美國及英國）
- Mandarin (Simplified Chinese) / 普通話（簡體中文）
- Urdu / 烏爾都語, Hindi / 印地語, Nepali / 尼泊爾語, and Tagalog / 他加祿語
Turn any lesson or explanation into a set of reviewable flashcards with a single click. The cards are generated right inside the chat and can be easily copied for use in other apps. 只需一鍵，就可以將任何課堂內容或解釋變成一組溫習卡。溫習卡會直接喺對話中生成，仲可以輕鬆複製到其他應用程式使用。
Follow these steps to get Obsidian Pal up and running. 跟住以下步驟，即可開始使用 Obsidian Pal。
Install the plugin via the Obsidian Community Plugins browser (once it's published) or manually from this repository. 透過 Obsidian 嘅「社群插件」瀏覽器安裝（發佈後），或從此處手動安裝。
After installing, go to Settings -> Community Plugins -> Obsidian Pal. You need to configure a few things:
安裝後，請到 設定 -> 社群插件 -> Obsidian Pal。你需要設定幾樣嘢：
-
Get an OpenRouter API Key:
-
獲取 OpenRouter API Key：
Obsidian Pal uses the OpenRouter service to connect to powerful AI models. You can get a free API key from their website. Many of the best models are available for FREE! Obsidian Pal 使用 OpenRouter 服務嚟連接強大嘅 AI 模型。你可以喺佢哋嘅網站免費申請一個 API Key。好多最勁嘅模型都係免費㗎！
- Go to OpenRouter.ai.
- Sign up and get your free API key.
- 前往 OpenRouter.ai。
- 註冊並獲取你嘅免費 API Key。
-
Enter API Key & Select a Model:
-
輸入 API Key 並選擇模型：
- Paste your OpenRouter API key into the first box.
- 將你嘅 OpenRouter API key 貼到第一個輸入框。
- From the "AI Model" dropdown, we recommend starting with a free model like
meta-llama/llama-4-maverick:free. - 喺「AI 模型」下拉選單中，我哋建議由免費模型開始，例如
meta-llama/llama-4-maverick:free。
-
Set Your Language:
-
設定你嘅語言：
- Choose your preferred language for the AI to chat with you in.
- 選擇你希望 AI 用咩語言同你溝通。
-
Choose Your Electives:
-
選擇你嘅選修科：
- Select the elective subjects you are taking. This is important! It helps Pal create dedicated folders for your notes and improves its ability to find relevant information when you ask questions.
- 選擇你正在修讀嘅選修科。呢一步好重要！佢可以幫助 Pal 為你嘅筆記創建專屬資料夾，並喺你問問題時提高搵到相關資料嘅準確性。
That's it! You're ready to go. 搞掂！你可以開始使用啦。
- Click the new robot icon (
🤖) in the left ribbon to open the Pal interface. - 點擊左邊欄新嘅機械人圖示 (
🤖) 打開 Pal 介面。 - You'll see three panes: Chat History (left), Weakness Tracker (left, in a tab), and the main Obsidian Pal chat view (right).
- 你會見到三個面板：對話歷史（左）、弱點追蹤器（左，喺分頁入面），以及主要嘅 Obsidian Pal 對話視窗（右）。
- In the main view, click "＋ New Chat" or choose one of the modes to begin a new session.
- 喺主視窗，點擊 "＋ 新對話" 或選擇其中一個模式嚟開始新嘅對話。
- Start chatting, learning, and quizzing! Your sessions will be saved automatically.
- 開始傾偈、學習同測驗啦！你嘅對話會自動儲存。
This project is the proud outcome of the 2025 Summer Steam Challenge, an initiative sponsored by the Bright Future Talent Hub X CityU. Our team, a group of students from Marymount Secondary School, is passionate about leveraging technology to create meaningful tools that empower students in Hong Kong. We believe that with the right support, every student can achieve their full potential. 呢個項目係 2025 夏季 STEAM 挑戰賽 嘅成果，由 Bright Future Talent Hub 及香港城市大學 聯合贊助。我哋團隊係一班嚟自瑪利曼中學嘅學生，對利用科技創造有意義嘅工具、幫助香港學生充滿熱情。我哋相信，只要有適當嘅支援，每個學生都可以發揮佢哋最大嘅潛能。
We hope Obsidian Pal becomes a valuable companion on your academic adventure. Good luck with your studies! 我哋希望 Obsidian Pal 可以成為你學術旅程上一個寶貴嘅夥伴。祝你學業進步！