# MateEngine for Linux (Unoffical) Github: https://github.com/Marksonthegamer/Mate-Engine-Linux-Port # Support MateEngine on Steam! Buy on Steam: https://store.steampowered.com/app/3625270/MateEngine/ Or use it for free here! Any Purchase on Steam will help Developement and future updates! Steam users get exclusive additional content: **Accessories** * Flower Halo * Sakura Halo * Retro Halo * ERROR! NSO Like Face Overlay! **Extra Features** * **Event-Based Messages** Generates cute messages when you drag the avatar, make it dance, or let it sit on windows or the taskbar. * **Steam Workshop Support** Access modifications, custom models, and dances. You can also create or download them from third-party websites. * **Automatic Updates** Always stay up to date with the latest version. # Note-Worthy Community Mods: Custom Dance Player https://github.com/maoxig/MateEngine-CustomDancePlayer # 🌐 Language / 言語選択 / 语言选择 - [English](#English) - [日本語](#Japanese) - [中文](#Chinese) --- ## English ![Mate Engine Preview](https://i.imgur.com/5cHHH8c.jpeg) # Mate Engine A free, lightweight alternative to **Desktop Mate** with custom VRM support and modding. Fewer limitations, more freedom. - **App License**: Mixed — GNU AGPL v3 & MateProv2 License *Please read the license terms carefully.* - **Default Avatar License**: All Rights Reserved by [Yorshka Shop](https://yorshkasencho.booth.pm/) *Do not redistribute this model in your builds.* - **QWEN 2.5 1.5b LLM**: *Apache License Version 2.0, January 2004* --- ## About the Project **Mate Engine** was created as a free alternative to **Desktop Mate** and others. Why? Because **Desktop Mate** charges **$10–$25 USD** for single character models—prices comparable to full games on Steam. On top of that, modding and custom models were disabled in later versions. **Mate Engine** solves both problems: - It's **completely free** - It supports **custom VRM avatars** - It’s **open-source and moddable** ![Mate Engine Preview](https://i.imgur.com/nNyWA1L.png) --- ## Free Hatsune Miku Support Want to try with a free model? [Download Hatsune Miku VRM](https://booth.pm/en/items/3226395) --- ## Feature Comparison Comparison between "Desktop Mate" "Phase Pal (Playtest Alpha)" "MateEngine" | Feature Comparisson | Desktop Mate (1.6.0) | Phase Pal (Alpha) | MateEngine (X3.0) | |--------------------------|--------------|-----------|------------| | Open Source | ❌ | ❌ | ✅ | | Mod Support | ❌ | ❌ | ✅ | | Custom VRM | ❌ | ✅ | ✅ | | Custom Shaders | ❌ | ❌ | ✅ | | .ME File Format | ❌ | ❌ | ✅ | | Window Sitting | ✅ | ✅ | ✅ | | Taskbar Sitting | ✅ | ✅ | ✅ | | Idle Animation | ✅ | ✅ | ✅ | | Dragging Animation | ✅ | ✅ | ✅ | | Dance to Music | ❌ | ❌ | ✅ | | Head Tracking | ✅ | ✅ | ✅ | | Spine Tracking | ❌ | ❌ | ✅ | | Eye Tracking | ❌ | ❌ | ✅ | | Hand Movement | ✅ | ❌ | ✅ | | Alarm / Timer | ✅ | ✅ | ✅ | | ScreenSaver | ❌ | ❌ | ✅ | | Touch Regions | ❌ | ❌ | ✅ | | Avatar SFX | ❌ | ❌ | ✅ | | Particle Effects | ✅ | ❌ | ✅ | | FPS Control | ❌ | ✅ | ✅ | | Always On Top Toggle | ❌ | ✅ | ✅ | | Chibi Mode | ❌ | ❌ | ✅ | | Post Processing Bloom | ❌ | ❌ | ✅ | | Post Processing AO | ❌ | ❌ | ✅ | | MSAA x8 Support | ✅ | ❌ | ✅ | | Big Screen Mode | ❌ | ❌ | ✅ | | System Icon | ✅ | ❌ | ✅ | | System Icon Settings | ❌ | ❌ | ✅ | | Smooth Anim Transitions | ❌ | ❌ | ✅ | | Steam Workshop | ❌ | ✅ | ✅ | | Built-In SDK | ❌ | ❌ | ✅ | | AI Chat | ❌ | ✅ | ✅ | | Advanced AI Functions | ❌ | ✅ | ✅ | | Markdown Support on AI | ❌ | ❌ | ✅ | | AI API Functions | ❌ | ✅ | ✅ | | Free To Use | ✅ | ✅ | ✅ | | Multi Language Support | ❌ | ✅ | ✅ | | AI Voices | ❌ | ✅ | ❌ | | Animation Modding | ❌ | ❌ | ✅ | | CPU Usage | Moderate | Very Good | Very Good | | GPU Usage | Moderate | Good | Good | | RAM Usage | Good | Very Bad | Very Good | | Anti Cheat Safe | ❌ | ❌ | ✅ | | Sleep | ❌ | ❌ | ✅ | | Compatible with Games | ❌ | ❌ | ✅ | | Start with PC | ❌ | ❌ | ✅ | | Blendshape Edit Support | ❌ | ❌ | ✅ | | Cosmetic Items | ❌ | ❌ | ✅ | | MMD Music Animation Player | ❌ | ❌ | ✅ | | Expression based on Movement | ✅ | ❌ | ✅ | | Discord Rich Presence | ❌ | ❌ | ✅ | | Inverse Kinematics | ❌ | ❌ | ✅ | | Masculine Animations | ❌ | ❌ | ✅ | | Menu Customizations | ❌ | ❌ | ✅ | | Debugging Menu | ❌ | ❌ | ✅ | | Up to 9 Avatars at the Same Time | ❌ | ❌ | ✅ | | Sync Dances between multiple Avatars | ❌ | ❌ | ✅ | | Minecraft Integration | ❌ | ❌ | ✅ | | Food System | ❌ | ❌ | ✅ | --- ## Steam Release Support ![Mate Engine Preview](https://i.imgur.com/Efp1AfG.png) **Funding Progress:** $239.34 / $100 **Target Date:** March 26, 2025 Thanks to the amazing support of the community, **Mate Engine** will be released on Steam for **$3.99** — but it will always remain **free on GitHub**. **Top Supporters:** - Gra**** Ja***** – $94.00 - Co**** Da***** – $96.00 - Dym**** Sk***** – $5.59 - Dreezer – $45.00 If you’d like to help with future updates or cover Steam fees, you can donate via **PayPal**: **johnson@soultechno.de** (*Please add a note: “MateEngine Donation”*) --- ## Smoother Transitions ![Mate Engine Preview](https://i.imgur.com/qS894h9.gif) Mate Engine offers smoother animation transitions than Desktop Mate, avoiding the glitchy, abrupt changes often found in commercial alternatives. --- ## Performance image **Mate Engine** is lightweight and efficient. RAM usage depends on the avatar’s texture size. For example, the high-quality "Alice" model uses ~190MB of texture memory, leading to ~200MB total RAM usage. Using lighter models will reduce this further. --- ## How to Use 1. Go to the **Releases** section (on the right-hand panel). 2. Download the ZIP file marked as a public release (not source code). 3. Unzip and run `MateEngineX.exe`. 4. Right-click the avatar or press `M` to open the settings menu. --- ## Developer Guide Want to contribute? Setup is easy: 1. Clone this repo and extract the folder. 2. Open **Unity Hub** → **Add Project From Disk** 3. Select the folder `Mate-Engine-BRANCH` 4. Load the project, then open the scene: `Scenes - USED FOR MATE ENGINE > Mate Engine Main` > ⚠️ Avoid scenes like *Mate Engine InDev* unless you're on the dev branch. --- ## Antivirus Notice If **Windows Defender** flags `Trojan:Script/Wacatac.B1ml`, **don’t worry** — this is a **false positive** caused by the app not being digitally signed. You can verify safety by scanning the app on [VirusTotal](https://www.virustotal.com/). --- ## Final Words Thanks for checking out **Mate Engine**! This project is made with love and designed to stay free forever. If you like it, share it or support it — but most of all, enjoy it. --------------------------------------------------------------------- ## Japanese ![Mate Engine Preview](https://i.imgur.com/5cHHH8c.jpeg) # Mate Engine（メイトエンジン） 軽量なインターフェースとカスタムVRM対応を備えた、無料のDesktop Mate代替アプリ。制限が少なく、より自由に。 - **アプリのライセンス**：混合 — GNU AGPL v3 & 著作権付きコンポーネント ※ライセンス内容をよくお読みください。 - **デフォルトアバターのライセンス**：[Yorshka Shop](https://yorshkasencho.booth.pm/) による著作権所有 ※このモデルを自作ビルドで再配布しないでください。 --- ## プロジェクトについて **Mate Engine** は、**Desktop Mate** の無料代替として開発されました。 理由はシンプルです：**Desktop Mate** のキャラモデルは 1体 **$10〜$25 USD** と高額で、これはSteamなどで販売されているフルゲームと同価格帯です。 さらに、後期バージョンでは**Mod対応が削除**され、カスタムモデルの導入が不可能になりました。 **Mate Engine** はこれらの問題を解決します： - 完全無料で利用可能 - カスタムVRMアバターをロード可能 - オープンソースかつMod対応 ![Mate Engine Preview](https://i.imgur.com/nNyWA1L.png) --- ## 初音ミクを無料で楽しもう 無料モデルを試したい方へ： [初音ミク VRMをダウンロード](https://booth.pm/en/items/3226395) --- ## 機能比較 「Desktop Mate」 「Phase Pal (Playtest Alpha)」 「MateEngine」の比較 | 機能 | Desktop Mate | Phase Pal | MateEngine | | --------------- | ------------ | --------- | ---------- | | オープンソース | ❌ | ❌ | ✅ | | Mod サポート | ❌ | ❌ | ✅ | | カスタム VRM | ❌ | ✅ | ✅ | | カスタムシェーダー | ❌ | ❌ | ✅ | | .ME ファイル形式 | ❌ | ❌ | ✅ | | ウィンドウ上に座る | ✅ | ✅ | ✅ | | タスクバー上に座る | ✅ | ✅ | ✅ | | アイドルアニメーション | ✅ | ✅ | ✅ | | ドラッグアニメーション | ✅ | ✅ | ✅ | | 音楽に合わせてダンス | ❌ | ❌ | ✅ | | 頭部トラッキング | ✅ | ✅ | ✅ | | 背骨トラッキング | ❌ | ❌ | ✅ | | 目のトラッキング | ❌ | ❌ | ✅ | | 手の動き | ❌ | ❌ | ✅ | | アラーム / タイマー | ✅ | ✅ | ✅ | | スクリーンセーバー | ❌ | ❌ | ✅ | | タッチ領域 | ❌ | ❌ | ✅ | | アバター効果音 (SFX) | ❌ | ❌ | ✅ | | パーティクルエフェクト | ❌ | ❌ | ✅ | | FPS 制御 | ❌ | ✅ | ✅ | | 常に最前面表示切替 | ❌ | ✅ | ✅ | | ちびキャラモード | ❌ | ❌ | ✅ | | ポストプロセス ブルーム | ❌ | ❌ | ✅ | | ポストプロセス AO | ❌ | ❌ | ✅ | | MSAA x8 サポート | ❌ | ❌ | ✅ | | ビッグスクリーンモード | ❌ | ❌ | ✅ | | システムアイコン | ✅ | ❌ | ✅ | | システムアイコン設定 | ❌ | ❌ | ✅ | | スムーズなアニメーション遷移 | ❌ | ❌ | ✅ | | Steam ワークショップ | ❌ | ✅ | ✅ | | 内蔵 SDK | ❌ | ❌ | ✅ | | AI チャット | ❌ | ✅ | ✅ | | 高度な AI 機能 | ❌ | ✅ | ❌ | | AI API 機能 | ❌ | ✅ | ❌ | | 無料利用可能 | ✅ | ✅ | ✅ | | 多言語サポート | ❌ | ✅ | ✅ | | AI ボイス | ❌ | ✅ | ❌ | | アニメーション Modding | ❌ | ❌ | ✅ | | CPU 使用率 | 普通 | 非常に良い | 非常に良い | | GPU 使用率 | 普通 | 良い | 良い | | RAM 使用率 | 非常に良い | 非常に悪い | 良い | | アンチチート安全 | ❌ | ❌ | ✅ | | スリープ機能 | ❌ | ❌ | ✅ | | ゲームとの互換性 | ❌ | ❌ | ✅ | --- ## Steam公開のご支援をお願いします！ ![Mate Engine Preview](https://i.imgur.com/Efp1AfG.png) **資金状況：** $239.34 / $100 **目標達成日：** 2025年3月26日 皆様のご支援により、**Mate Engine** は **$3.99** でSteam公開されます。 ただし、**GitHubではこれからも完全無料です！** **支援者の皆様：** - Gra**** Ja***** – $94.00 - Co**** Da***** – $96.00 - Dym**** Sk***** – $5.59 - Dreezer – $45.00 **支援はこちらから：** PayPal: **johnson@soultechno.de** （※「MateEngine Donation」と記載してください） --- ## スムーズなアニメーション遷移 ![Mate Engine Preview](https://i.imgur.com/qS894h9.gif) Mate Engineは**非常に滑らかなアニメーション遷移**を実現しています。 Desktop Mateのようなカクつきや状態切り替えのバグがなく、常に自然な動きを保ちます。 --- ## パフォーマンス ![Mate Engine Preview](https://i.imgur.com/MTbnIeE.png) **Mate Engine** は軽量かつ省リソース設計。使用するモデルによってRAM消費は変動します。 例：「Alice」モデルではテクスチャが約190MBで、合計約200MBのRAMを使用します。 より軽量なモデルを使用すればさらに負荷は低下します。 --- ## 主な機能 - **アイドルアニメーション** – デスクトップ上でループ再生 - **ドラッグアニメーション** – 移動時にふわっと浮遊 - **ダンス機能（実験的）** – SpotifyやFirefoxなどで音楽に反応 - **VRMインジェクト** – 任意の正しい`.VRM`モデルを使用可能 - **タッチリアクション** – 顔や頭のタッチに反応 - **カスタムMod対応** – サウンド・パーティクルなどを自由に追加 - **オプションメニュー** – ペットを右クリック、または`M`キーで開く - **FPS設定、最前面表示、ちびモード** なども搭載 --- ## 今後のアップデート（Pre-Release 5〜10） - **Wallpaper Engine連携** – 壁紙内にMate Engineを埋め込み可能 - **ウィンドウ／タスクバーに座る機能** – 実装難易度高めですが検討中 - **メニュー色カスタマイズ** – お好みに合わせてテーマ変更可能 --- ## 使い方 1. 右の「Releases」セクションから最新版ZIPをダウンロード 2. `MateEngineX.exe` を展開し、実行 3. ペットを右クリック、または `M` を押してオプションメニューを開く --- ## よくある質問 **Q: VRMモデルが読み込めません！** **A:** 多くの場合、モデルのエクスポート設定に問題があります。正しくボーンが設定されているか、互換性のあるシェーダーを使っているかご確認ください。 **Q: 初音ミクは最初から入っていますか？** **A:** 含まれていません。上記のBoothリンクから無料でダウンロードしてください。 **VRM変換の参考ガイド：** [公式VRM変換ガイド](https://vrm.dev/en/vrm/how_to_make_vrm/) ※VRMファイルの作成サポートは本プロジェクトの対象外です。 --- ## 開発者向けセットアップ Mate Engineの開発に参加するのはとても簡単です： 1. GitHubリポジトリをクローンし、展開 2. **Unity Hub** を開き、「Add Project From Disk」を選択 3. `Mate-Engine-BRANCH` フォルダを選択 4. プロジェクトを開き、以下のシーンを開く： `Scenes - USED FOR MATE ENGINE > Mate Engine Main` > ⚠️ *Mate Engine InDev* などの別ブランチ用シーンは開かないでください。 --- ## ウイルス検出に関する注意 **Windows Defender** が `Trojan:Script/Wacatac.B1ml` を検出する場合がありますが、**これは誤検知**です。 アプリが**デジタル署名されていない**ために起こる問題です。 心配な方は [VirusTotal](https://www.virustotal.com/) などでスキャンしてください。 --- ## 最後に **Mate Engine** を楽しんでいただけたら嬉しいです！ このプロジェクトはこれからも無料で公開していきます。 支援やシェアも大歓迎ですが、何よりもまずは使って楽しんでください！ ## Chinese ![Mate Engine Preview](https://i.imgur.com/5cHHH8c.jpeg) # Mate Engine（伙伴引擎） 一款免费、轻量级的 **Desktop Mate** 替代品，支持自定义VRM模型和模组功能。更少限制，更多自由。 - **应用程序许可证**：Mixed — GNU AGPL v3 & MateProv2 License *请仔细阅读许可证条款。* - **默认角色许可证**：由 [Yorshka Shop](https://yorshkasencho.booth.pm/) 保留所有权利 *请勿在您的构建中重新分发此模型。* - **QWEN 2.5 1.5b LLM**：*Apache许可证 版本2.0，2004年1月* # 在Steam上支持MateEngine！ 在Steam上购买：https://store.steampowered.com/app/3625270/MateEngine/ 也可以在此免费使用！在Steam上的任何购买都将有助于开发和未来的更新！ --- ## 关于项目 **Mate Engine** 是作为 **Desktop Mate** 等软件的免费替代品而创建的。 为什么？因为 **Desktop Mate** 对单个角色模型收取 **10–25美元** —— 这与Steam上全价游戏相当。更糟糕的是，后续版本禁用了模组功能和自定义模型。 **Mate Engine** 解决了这两个问题： - 它是**完全免费**的 - 它支持**自定义VRM角色** - 它是**开源且支持模组**的 ![Mate Engine Preview](https://i.imgur.com/nNyWA1L.png) --- ## 免费初音未来支持 想尝试免费模型吗？ [下载初音未来VRM模型](https://booth.pm/en/items/3226395) --- ## 功能对比 "Desktop Mate" "Phase Pal (Playtest Alpha)" "MateEngine" 的功能对比 | 功能对比 | Desktop Mate (1.6.0) | Phase Pal (Alpha) | MateEngine (1.9.8) | |--------------------------|--------------|-----------|------------| | 开源 | ❌ | ❌ | ✅ | | 模组支持 | ❌ | ❌ | ✅ | | 自定义VRM | ❌ | ✅ | ✅ | | 自定义着色器 | ❌ | ❌ | ✅ | | .ME文件格式 | ❌ | ❌ | ✅ | | 窗口坐立 | ✅ | ✅ | ✅ | | 任务栏坐立 | ✅ | ✅ | ✅ | | 待机动画 | ✅ | ✅ | ✅ | | 拖拽动画 | ✅ | ✅ | ✅ | | 随音乐起舞 | ❌ | ❌ | ✅ | | 头部追踪 | ✅ | ✅ | ✅ | | 脊柱追踪 | ❌ | ❌ | ✅ | | 眼部追踪 | ❌ | ❌ | ✅ | | 手部动作 | ❌ | ❌ | ✅ | | 闹钟/计时器 | ✅ | ✅ | ✅ | | 屏幕保护 | ❌ | ❌ | ✅ | | 触摸区域 | ❌ | ❌ | ✅ | | 角色音效 | ❌ | ❌ | ✅ | | 粒子效果 | ❌ | ❌ | ✅ | | FPS控制 | ❌ | ✅ | ✅ | | 始终置顶切换 | ❌ | ✅ | ✅ | | 迷你模式 | ❌ | ❌ | ✅ | | 后处理光晕 | ❌ | ❌ | ✅ | | 后处理环境光遮蔽 | ❌ | ❌ | ✅ | | MSAA x8支持 | ❌ | ❌ | ✅ | | 大屏幕模式 | ❌ | ❌ | ✅ | | 系统图标 | ✅ | ❌ | ✅ | | 系统图标设置 | ❌ | ❌ | ✅ | | 平滑动画过渡 | ❌ | ❌ | ✅ | | Steam创意工坊 | ❌ | ✅ | ✅ | | 内置SDK | ❌ | ❌ | ✅ | | AI聊天 | ❌ | ✅ | ✅ | | 高级AI功能 | ❌ | ✅ | ❌ | | AI API功能 | ❌ | ✅ | ❌ | | 免费使用 | ✅ | ✅ | ✅ | | 多语言支持 | ❌ | ✅ | ✅ | | AI语音 | ❌ | ✅ | ❌ | | 动画模组 | ❌ | ❌ | ✅ | | CPU使用率 | 中等 | 非常好 | 非常好 | | GPU使用率 | 中等 | 良好 | 良好 | | RAM使用率 | 非常好 | 非常差 | 良好 | | 反作弊安全 | ❌ | ❌ | ✅ | | 睡眠功能 | ❌ | ❌ | ✅ | | 游戏兼容性 | ❌ | ❌ | ✅ | | 随电脑启动 | ❌ | ❌ | ✅ | | 表情编辑支持 | ❌ | ❌ | ✅ | --- ## Steam发布支持 ![Mate Engine Preview](https://i.imgur.com/Efp1AfG.png) **资金进度：** $239.34 / $100 **目标日期：** 2025年3月26日 感谢社区的大力支持，**Mate Engine** 将以 **$3.99** 的价格在Steam上发布 —— 但它在GitHub上永远是**免费**的。 **顶级支持者：** - Gra**** Ja***** – $94.00 - Co**** Da***** – $96.00 - Dym**** Sk***** – $5.59 - Dreezer – $45.00 如果您想帮助未来更新或支付Steam费用，可以通过**PayPal**捐赠： **johnson@soultechno.de** (*请添加备注："MateEngine Donation"*) --- ## 更流畅的过渡 ![Mate Engine Preview](https://i.imgur.com/qS894h9.gif) Mate Engine提供比Desktop Mate更流畅的动画过渡，避免了商业替代品中常见的卡顿和突然变化。 --- ## 性能 ![Mate Engine Preview](https://i.imgur.com/MTbnIeE.png) **Mate Engine** 轻巧高效。RAM使用量取决于角色的纹理大小。例如，高质量的"Alice"模型使用约190MB的纹理内存，导致约200MB的总RAM使用量。使用较轻的模型将进一步减少这一消耗。 --- ## 主要功能 - **待机动画** – 在桌面上循环播放 - **拖拽动画** – 移动时轻轻漂浮 - **跳舞功能（实验性）** – 对Spotify或Firefox等中的音乐做出反应 - **VRM导入** – 可以使用任何正确的`.VRM`模型 - **触摸反应** – 对脸部和头部的触摸做出反应 - **自定义模组支持** – 自由添加声音、粒子等 - **选项菜单** – 右键点击角色或按`M`键打开 - **FPS设置、始终置顶、迷你模式** 等功能也已搭载 --- ## 使用方法 1. 前往右侧的**Releases**部分。 2. 下载标记为公开发布的ZIP文件（非源代码）。 3. 解压缩并运行`MateEngineX.exe`。 4. 右键点击角色或按`M`键打开设置菜单。 --- ## 开发者指南 想贡献代码？设置很简单： 1. 克隆此仓库并解压文件夹。 2. 打开**Unity Hub** → **从磁盘添加项目** 3. 选择`Mate-Engine-BRANCH`文件夹 4. 加载项目，然后打开场景： `Scenes - USED FOR MATE ENGINE > Mate Engine Main` > ⚠️ 除非您在开发分支上，否则请避免打开*Mate Engine InDev*等场景。 --- ## 防病毒软件注意事项 如果**Windows Defender**标记`Trojan:Script/Wacatac.B1ml`，**请不要担心** —— 这是由于应用程序未经过数字签名而导致的**误报**。 您可以在[VirusTotal](https://www.virustotal.com/)上扫描应用程序以验证安全性。 --- ## 最后的话 感谢您查看**Mate Engine**！ 这个项目是用爱制作的，并旨在永远免费提供。 如果您喜欢它，请分享或支持它 —— 但最重要的是，享受它。 --------------------------------------------------------------------