Greatdori

KO | EN

gitlite — search

#python #ai #typescript #go #android #rust #java #windows #kubernetes #vue #security #mcp #openai #open-source

(★ 12)

A great reference app for BanG Dream! GBP on Apple platforms.

Greatdori Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Greatdori!

Greatdori includes iOS, iPadOS, macOS and watchOS app,
built with [DoriKit](https://github.com/Greatdori/DoriKit).

| **Platform** | **Status** |
|---:|:---:|
| iOS & watchOS | ![Greatdori iOS & watchOS Build Status](https://img.shields.io/github/actions/workflow/status/Greatdori/Greatdori/build-greatdori.yml)|
| macOS         | ![Greatdori macOS Build Status](https://img.shields.io/github/actions/workflow/status/Greatdori/Greatdori/build-greatdori-mac.yml)|
| visionOS      | ![Greatdori visionOS Build Status](https://img.shields.io/github/actions/workflow/status/Greatdori/Greatdori/build-greatdori-xr.yml)|

This open source version is called *Sayuru*,
which enables features like music streaming that App Store might not allow to do so.

## Downloads
- [App Store](https://apps.apple.com/app/id6749022770)
- [TestFlight (Nightly Build)](https://testflight.apple.com/join/hTXga49Q)

## Building

Xcode 26.0 and Swift 6.2+ is required for building this project.

CMake is also required for building from Xcode Project, you can install it by Homebrew if you don't have one:
```sh
brew install cmake
```

### Workspace

The initiailzation script below will create a folder `Greatdori` and download all the files needed.

```sh
step=1 && mkdir Greatdori && \
cd "Greatdori" && \
step=2 && git clone https://github.com/Greatdori/Greatdori.git && \
cd "Greatdori" && \
step=3 && utils/update-checkout --clone && \
step=4 && utils/generate-workspace && \
echo "Greatdori: succeed." && \
cd ../.. || \
echo "Greatdori: something went wrong at step $step. Learn more at README.md."
```

If necessary, use `utils/update-checkout` to update all relying repositories later. Use `utils/generate-workspace` to generate workspace.

If something's wrong, please look at the step-by-step instructions below and find the corresponding step. Try to run the step again, and if issue still occurs, please report to us.

#### Break Down

1. First, create a directory for the Greatdori! project:

```sh
mkdir Greatdori
cd Greatdori
```

2. Then clone this project by Git:

```sh
git clone https://github.com/Greatdori/Greatdori.git
cd Greatdori
```

Note that there should be two `Greatdori` folders,
your current path like this:

```sh
$ pwd
/path/to/Greatdori/Greatdori
```

3. Use the `utils/update-checkout` script to checkout all repositories
that Greatdori! needs. Add `--clone` option for the first time
to clone all repositories:

```sh
utils/update-checkout --clone
```

4. After cloning all repositories needed, use `utils/generate-workspace`
to generate a `xcworkspace` for building project:

```sh
utils/generate-workspace
```

Open `Greatdori.xcworkspace`, then select a scheme you want to build.

### Schemes
There're several schemes in Greatdori! project:

- **Greatdori**: The Greatdori! app for iOS, iPadOS and macOS;
- **Greatdori Widgets**: Widget extension for **Greatdori** scheme;
- **Greatdori Watch App**: The Greatdori! app for watchOS;
- **Greatdori Watch Widgets**: Widget extension for **Greatdori Watch App** scheme;
- **BuiltinCardCollections**: Built-in card collection for widgets;
- **Greatdori Installer**: Generates a `pkg` installer for macOS app;
- **CardCollectionGen**: A CLI tool which generates built-in card collections;
- **GreatLyrics**: A tool for making lyrics file of songs.

Besides, some targets have a corresponding *Without Pre-Cache* scheme,
which builds the target without [pre-cache](#pre-cache) for DoriKit.

### Pre-Cache
To make it faster to get some data which is updated less frequent,
DoriKit generates a `PreCache.cache` file in **compile-time**
and embeds it to `DoriKit.framework` bundle. This allows you to get some information
like character list from `DoriCache.preCache` without performing a network request.

Pre-Cache generation happens when you first build DoriKit for a configuration,
after you cleaned build folder, or if the previous generation date was over a week ago.
If you're experiencing a poor network connection
that makes you can't generate pre-cache successfully,
you can opt-out it by building your target from `Without Pre-Cache` scheme.

### Code Signing
All development teams of each targets are set to `Yuxuan Chen (8CZ4JT4F3M)`
which makes it easier for our CI runs and distribution workflows.
You have to change it to your own team before building,
or choose *None* if you build it only for simulator or macOS.
(And don't forget to change it back if you'd like to open a pull request!)

## Contributing to Greatdori!
Contributions to Greatdori! are welcomed and encouraged!
Fork the project, make changes and open your pull requests!

If you're experiencing some bugs, or have any suggestion to Greatdori!,
filing an issue for it is also welcomed.

```mermaid
---
config:
  layout: elk
---
flowchart TD;
    GA["Greatdori"] --> DK["DoriKit"] & GW["Greatdori Widgets"] & BCC["BuiltinCardCollections"]
    GWA["Greatdori Watch App"] <--> GA
    GW --> DK & BCC
    GWA --> DK & BCC & GWW["Greatdori Watch Widgets"]
    GWW --> DK & BCC
    BCC --> DK
    DKT["DoriKitTests"] --> DK
    DK --> DE["DoriEmoji"]
    DK --> DR["DoriResource"]
    DK --> DKM["DoriKitMacros"]
    DK -.-> PCG["PreCacheGen"]
    DK -.-> DAS["DoriAssetShims"]
    GI["Greatdori Installer"] --> GA
    CCG["CardCollectionGen"] --> DK
    GL["GreatLyrics"] --> DK
```

## License
This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE.txt) file for details.

Greatdori

Greatdori Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Greatdori

Greatdori Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README