mirror of
https://github.com/vicstu/obsidian_max_sync.git
synced 2026-07-22 08:31:03 +00:00
No description
| src | ||
| LICENSE | ||
| main.js | ||
| manifest.json | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| versions.json | ||
MAX Sync
Sync messages from MAX messenger into your Obsidian vault.
The plugin fetches new messages from a companion sync server, appends them to a target note (with an optional template), and downloads media attachments into your vault.
Desktop only (Obsidian 1.5.0+).
Requirements
- Obsidian desktop
- A running MAX Sync backend and bot that issues your personal user token
- A user token from the bot (
/token)
Installation
From Community Plugins (after publication)
- Open Settings → Community plugins
- Turn off Safe mode
- Browse and install MAX Sync
- Enable the plugin
Manual install
- Download
main.jsandmanifest.jsonfrom the latest GitHub Release of this repository - Create the folder
<vault>/.obsidian/plugins/max-sync/ - Copy the files into that folder
- Enable MAX Sync under Community plugins
Setup
- In MAX, send
/tokento the bot and copy the token - Open Settings → MAX Sync
- Paste the token into Max user token
- Click Check to verify the server and token
- Optionally set:
- Template file (default:
MAX/template.md) - Target file (default:
MAX/Inbox.md) - Attachments folder (default:
Attachments)
- Template file (default:
Usage
Run the command Fetch new messages (Command palette).
New messages are appended to the target file. Attachments are saved under the attachments folder.
Template variables
If you use a template file, these placeholders are supported:
| Variable | Description |
|---|---|
{{date}} |
Message date |
{{time}} |
Message time |
{{created}} |
Creation timestamp |
{{sender}} |
Sender display name |
{{sender_id}} |
Sender ID |
{{message_id}} |
Message ID |
{{type}} |
Message type |
{{text}} |
Message text |
{{attachment}} |
Attachment link/line |
{{transcription}} |
Transcribed audio text (if any) |
{{tags}} |
Tags |
Development
npm install
npm run dev # watch build
npm run build # production build → main.js
License
MIT — see LICENSE.