Skip to content

Latest commit

 

History

History
71 lines (37 loc) · 3.15 KB

README_en.md

File metadata and controls

71 lines (37 loc) · 3.15 KB

20240905161248130-b9c1d9d9-903d-4473-baa1-223d600c3b88


| 简体中文 | English |

CyanStars

Music, the universal language of the cosmos.

CyanStars is a Chinese virtual singer fan-made, non-commercial, community music game developed by the Infinite Pursuit of Light Development Team (IPOL).

Contributing

Before you start contributing, please take a moment to read the Contribution Guidelines, thank you very much!

Please use the specifications outlined in LICENSE and NOTICE for source code and multimedia files.

If you wish to publish modified game files, please clearly state expressions like "This game has been modified and is not the original IPOL version" to differentiate your work from what is released in this repository. Modified game files must not be copyrighted in any country/region.

Do you have the ability to contribute to the project and document translation? Please assist us on Crowdin or submit via PR.

Related Links

Community contributors/included tracks/privacy policy, etc., can be found in the Associated Documents.

Multimedia files are referenced as submodules at the path Cyan-Stars/Assets/CysMultimediaAssets. Please refer to the submodule repository documentation for contribution guidelines regarding multimedia files.

Do you have expertise in art/music/charting/programming/translation, etc., and are interested in participating in our internal discussions? Feel free to apply to join us here.

Player Communication Discord Group (Work in Progress)

For copyright, security, members and community, or other issues, please feel free to contact us at [email protected].

Development Documentation

Cloning the repository and submodules (if using the git command line)

git clone --recurse-submodules https://github.com/IPOL-Studio/CyanStars.git

or

git clone https://github.com/IPOL-Studio/CyanStars.git
cd CyanStars
git submodule update --init --recursive

Download Unity Editor

If you have Unity Hub installed, you can copy this link to your browser to launch Unity Hub for download: unityhub://2020.3.28f1/f5400f52e03f.

Alternatively, manually download version 2020.3.28f1 of the editor from the Unity official website.

Download Other Necessary Resources

Live2D Cubism SDK for Unity - A third-party Unity package for playing Live2D resources in Unity projects. After agreeing to the license, download and drag it into the Unity editor for import, then restart the editor.

Build Installation Package

Select CyanStars 工具箱 (CyanStars Toolbox) from the menu above the Unity editor for building.