repository·master·Indexed 19 days ago
https://github.com/ultrastar-deluxe/playA free and open-source singing game built with the Unity engine and C# where players sing along to audio files with lyrics and notes. The documentation covers development setup, contribution guidelines, CPU requirements for Whisper for Unity (AVX/AVX2), runtime script loading via Mono.CSharp.dll, and configuration for GeneralUser GS SoundFont banks.
The Feather icon set used in the playsharedui package is licensed under the MIT license. You can find the original icon source and font implementation at the following links:
GeneralUser GS is a GM and GS compatible SoundFont bank. To ensure all 259 instrument presets sound correct, you must use a SoundFont synth that supports SoundFont 2.01 modulators.
Using a synth that does not support these modulators may result in broken or incorrect-sounding presets. If your software is incompatible, the author suggests using an older "SoftSynth" version of the bank (available on the author's website) which uses less specialized programming.
Noto Emoji is provided as a variable font, which allows you to access a continuous range of weights through a single file. This is useful if your application supports variable font axes.
Available Axis:
wght (Weight)Variable Font File:
NotoEmoji-VariableFont_wght.ttfNotoEmoji-VariableFont_wght.ttfRoboto Mono is provided in two formats: Variable Fonts and Static Fonts.
If your application supports variable fonts, use the following files to access all styles via the wght axis. This allows you to select intermediate weights not available in static files.
RobotoMono-VariableFont_wght.ttfRobotoMono-Italic-VariableFont_wght.ttfIf your application does not support variable fonts, use the individual files located in the static/ directory:
static/RobotoMono-Thin.ttfstatic/RobotoMono-ExtraLight.ttfstatic/RobotoMono-Light.ttfstatic/RobotoMono-Regular.ttfstatic/RobotoMono-Medium.ttfstatic/RobotoMono-SemiBold.ttfstatic/RobotoMono-Bold.ttfstatic/RobotoMono-ThinItalic.ttfstatic/RobotoMono-ExtraLightItalic.ttfstatic/RobotoMono-LightItalic.ttfstatic/RobotoMono-Italic.ttfstatic/RobotoMono-MediumItalic.ttfstatic/RobotoMono-SemiBoldItalic.ttfstatic/RobotoMono-BoldItalic.ttfThe Inter font package provides two ways to use the font depending on your application's support for variable fonts:
Variable Font: If your application supports variable fonts, use the single file Inter-VariableFont_slnt,wght.ttf. This file contains all styles and allows you to select intermediate styles along the following axes:
slnt (slant)wght (weight)Static Fonts: If your application does not support variable fonts, use the individual files located in the static/ directory:
static/Inter-Thin.ttfstatic/Inter-ExtraLight.ttfstatic/Inter-Light.ttfstatic/Inter-Regular.ttfstatic/Inter-Medium.ttfstatic/Inter-SemiBold.ttfstatic/Inter-Bold.ttfstatic/Inter-ExtraBold.ttfstatic/Inter-Black.ttfSetup Steps:
Contributions are welcome across several domains:
For guidance on your first contribution, join the community on Discord to meet the maintainers.
The playsharedui package includes Noto Sans JP in two formats: a single variable font file and a collection of static font files.
If your application supports variable fonts, use the single file NotoSansJP-VariableFont_wght.ttf. This file contains all styles via the wght axis, allowing you to select intermediate weights not present in static files.
If your application does not support variable fonts, use the individual files located in the static/ directory:
static/NotoSansJP-Thin.ttfstatic/NotoSansJP-ExtraLight.ttfstatic/NotoSansJP-Light.ttfstatic/NotoSansJP-Regular.ttfstatic/NotoSansJP-Medium.ttfstatic/NotoSansJP-SemiBold.ttfstatic/NotoSansJP-Bold.ttfstatic/NotoSansJP-ExtraBold.ttfstatic/NotoSansJP-Black.ttfFiles available:
- NotoSansJP-VariableFont_wght.ttf (Variable)
- static/NotoSansJP-Thin.ttf
- static/NotoSansJP-ExtraLight.ttf
- static/NotoSansJP-Light.ttf
- static/NotoSansJP-Regular.ttf
- static/NotoSansJP-Medium.ttf
- static/NotoSansJP-SemiBold.ttf
- static/NotoSansJP-Bold.ttf
- static/NotoSansJP-ExtraBold.ttf
- static/NotoSansJP-Black.ttfTo use GeneralUser GS as your primary bank, follow your specific synthesizer or sound card's documentation.
General requirement: GeneralUser GS typically needs to be loaded into bank 0. Ensure that any other SoundFonts currently occupying bank 0 are removed before loading GeneralUser GS.
The Mono.CSharp.dll provided in this directory is a version of the library found in UnityEditor/2022.3.9f1/Editor/Data/MonoBleedingEdge/lib/mono/4.5. It can be utilized to enable runtime script loading and compilation within the application, a technique commonly used for game modding in Unity environments.
For detailed technical implementation details on how to use this for modding, refer to the external guide: https://somasim.com/blog/2017/12/27/tech-notes-unity-game-modding/
To use Noto Emoji in your project:
To use Roboto Mono in your project, follow these steps:
The Noto Sans Sinhala font package provides two ways to implement the font depending on your application's capabilities:
Variable Font: If your application supports variable fonts, use the single file NotoSansSinhala-VariableFont_wdth,wght.ttf. This file contains all styles and allows you to pick intermediate styles using the following axes:
wdth (width)wght (weight)Static Fonts: If your application does not support variable fonts, use the individual .ttf files located in the static/ directory. These files cover various widths (ExtraCondensed, Condensed, SemiCondensed, and Regular) and weights (Thin to Black).
Setup Steps:
Variable Font:
NotoSansSinhala-VariableFont_wdth,wght.ttf
Static Fonts (examples):
static/NotoSansSinhala_ExtraCondensed-Thin.ttf
static/NotoSansSinhala_Regular.ttf
static/NotoSansSinhala_Black.ttf