Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 3.8 KB

README_en_US.md

File metadata and controls

52 lines (43 loc) · 3.8 KB
Raw

Genshin, Launch!

This project replaces some files in the Siyuan installation directory, modifying the startup page and lock screen page to the UI style of Genshin Impact.

English | 简体中文

Features

  • Startup page simulates Genshin Impact UI.
  • Lock screen page simulates Genshin Impact UI and changes with local time.
  • Loading page with Genshin Impact loading icon.
  • Replace App Icon.
  • Paimon as a virtual assistant.
    • Provide OnOff in setting.
    • Provide Mute option in setting.
    • Provide mouse penetration for clicking and other operations

Installation Notes

  • The copyright of the images, icons, music, and video clips used in this plugin belongs to miHoYo. This plugin is not an official feature of SiYuan Note, but was created by the plugin author for personal learning of front-end development. It is provided as teaching and learning purposes for plugin developers. All code and materials are publicly available for free, please do not use for other commercial purposes.
  • This plugin achieves its functionality by replacing files in the installation directory, which will affect all workspaces!**
  • Currently only supports Windows, MacOS, and Linux
    • Windows requires administrator privileges for replacement (Installed into C:\Program Files globally).
    • The Linux version only support unzip installation from tar.gz.
      • AppImage running in a temporary folder so replacement does not work
      • Install by package manager (e.g. apt-get, AUR) has priviliage problem when replacing files
    • The f**king stupid file permission in the Android 11+ completely blocks this technical approach.
  • Reinstalling SiYuan can solve all issues caused by this plugin. After reinstalling, need to re-run the plugin.
  • Remember to enable the lock screen feature in Settings - About - Access Authorization Code for better experience.
    • The lock screen page has background music, but Chrome security permissions require manual click to trigger playback.
  • Light and dark mode change according to local time (6:00 to 18:00 as light mode), following Genshin's logic rather than SiYuan's mode setting.
  • The plugin also has the capability to automatically replace the application icon.
    However, on Mac, due to icon caching, the changes may not take effect immediately and even after restart.
    Please manually replace the icon by the following step (click to open image tuturials):
    Image Translation: Applications -> SiYuan.app -> (1) Get Info (2) Show package contents -> Drag icon from package contents to icon area in info panel.
  • The Paimon Assistant function is only for temporary use, and there are NO** plans to provide more advanced customization options such as moving position or changing models. Please look forward to the updates of the Waifu plugin for more comprehensive features.
    Rendering the Paimon is very comutation intensive, not recommended using on low performance computer or with battery

References