[!IMPORTANT]
📢 We are looking for co-maintainers!
Currently, the project has only one active maintainer with limited bandwidth. If you’re interested in helping maintain AMLL, please check our 招募维护者 / Looking for Maintainers and Contribution Guide.
You can also reach us via QQ Group (678038548) or Discord Server.
AMLL Ecology and source code structure
Main modules
: AMLL Core Component Library, written natively with DOM, provides lyric display component and dynamic fluid background component
: AMLL React binding, provides React component forms of lyric display and dynamic fluid background components
: AMLL Vue binding, provides Vue component forms of lyric display and dynamic fluid background components
: AMLL lyric parsing module, provides parsing and serialization support for various lyric formats including LyRiC, YRC, QRC, and Lyricify Syllable
Browser compatibility alerts
This component framework requires the following browsers or newer versions at a minimum:
- Chromium/Edge 91+
- Firefox 100+
- Safari 9.1+
To fully render all component effects, the following browser versions or newer are required:
- Chromium 120+
- Firefox 100+
- Safari 15.4+
Reference Links:
Performance benchmarks have shown that mainstream CPU processors from the last five years can run the lyric component at 30FPS. However, if you need smooth 60FPS operation, ensure your CPU frequency is at least 3.0GHz or higher. For 144FPS or above, a CPU frequency of at least 4.2GHz is recommended.
GPU performance capable of running at full 60 fps at the expected sizes under the following conditions:
1080p (1920x1080): NVIDIA GTX 10 series and above
2160p (3840x2160): NVIDIA RTX 2070 and above
Development/build/packaging process
Prerequisites
Building the component libraries
Clone this repository, then run the following commands in the project root:
# Install dependencies
pnpm install
# Production build (all library packages)
pnpm run build:libs
Building a single package
# Example: build only @applemusic-like-lyrics/core
pnpm nx run @applemusic-like-lyrics/core:build
# Example: development build of @applemusic-like-lyrics/lyric
pnpm nx run @applemusic-like-lyrics/lyric:build:dev
Acknowledgements
Special Thanks
Thanks to
JetBrains for their development tools that provide great support to the AMLL project
评论