# utaformatix3

**Repository Path**: fon1173/utaformatix3

## Basic Information

- **Project Name**: utaformatix3
- **Description**: utaformatix3国内镜像
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-07-18
- **Last Updated**: 2024-06-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# UtaFormatix3

[![Discord](https://img.shields.io/discord/984044285584359444?style=for-the-badge&label=discord&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/TyEcQ6P73y)

UtaFormatix is an application for converting projects among singing voice synthesizer softwares.

The current version `3.x` is built with [Kotlin for JavaScript](https://kotlinlang.org/docs/reference/js-overview.html)
and [React](https://github.com/facebook/react).

## Features

- Supported importing formats: `.vsqx(3/4)`, `.vpr`, `.vsq`, `.mid(VOCALOID)`, `.ust`, `.ustx`, `.ccs`,`.xml(MusicXML)`
  , `.musicxml`, `.svp`, `.s5p`, `.dv`, `.ppsf(NT)`, `.ufdata`
- Supported exporting formats: `.vsqx(4)`, `.vpr`, `.vsq`, `.mid(VOCALOID)`, `.ust`, `.ustx`, `.ccs`, `.xml(MusicXML)`
  , `.svp`, `.s5p`, `.dv`, `.ufdata`
- Keep information including: tracks, notes, tempo labels, time signatures
- Detect and convert Japanese lyrics types
    - between CV and VCV
    - between Kana and Romaji
- Find/Replace texts in the lyrics
- Convert pitch for the following supported formats

| Format               | Pitch import | Vibrato import | Pitch export |
|----------------------|--------------|----------------|--------------|
| VSQ/VSQX/VPR/MID(V1) | ✓            |                | ✓            |
| UST(mode2)           | ✓            | ✓              | ✓            |
| UST(mode1)           | ✓            | N/A            | ✓            |
| USTX                 | ✓            | ✓              | ✓            |
| CCS                  | ✓            |                | ✓            |
| SVP                  | ✓            | ✓              | ✓            |
| S5P                  | ✓            |                | ✓            |
| DV                   | ✓            | ✓              | ✓            |

## Open format published (.ufdata)

We have published the internal data format of UtaFormatix
to [UtaFormatix Data](https://github.com/sdercolin/utaformatix-data).

If you are developing OSS projects related to singing voice synthesis, you may find it useful.

## Contributors

[sdercolin](https://github.com/sdercolin), [ghosrt](https://github.com/ghosrt)
, [shine5402](https://github.com/shine5402)

## Localization help

[時雨ゆん](https://twitter.com/Yun_Shigure), [KagamineP](https://github.com/KagamineP)
, [Exorcism0666](https://github.com/Exorcism0666)

## Get started for development

1. Install [IntelliJ IDEA](https://www.jetbrains.com/idea/)
2. Clone and import as a Gradle project
3. Configure IDEA's Gradle settings with `JDK 11` and `Use Gradle from: gradle-wrapper.properties file`
4. Run by `./gradlew run` or Gradle Task `other/run`

## Contribution

Code contribution is welcomed. Basically, please cut your branch from `develop` and make Pull Requests towards `develop`
branch.

#### Adding a format support

Please check [Format.kt](https://github.com/sdercolin/utaformatix3/blob/master/src/main/kotlin/model/Format.kt) and its
usages.

#### Adding a Language

Please check [Strings.kt](https://github.com/sdercolin/utaformatix3/blob/master/src/main/kotlin/ui/strings/Strings.kt).

#### Adding a configurable process

Please
check [ConfigurationEditor.kt](https://github.com/sdercolin/utaformatix3/blob/master/src/main/kotlin/ui/ConfigurationEditor.kt)
about how the existing processes work.

#### Build/Format check

Pull requests require build check to be merged. Besides normal building of the project, a format check is conducted.
Please confirm that the `build` and `ktlintCheck` Gradle tasks pass before submitting your code.

You may find `ktlintFormat` task helpful, which helps fix most format problems.

If your IDE's formatter is conflicting with `ktlint`, please import format settings
from [.editorconfig](https://github.com/sdercolin/utaformatix3/blob/master/.editorconfig) (IntelliJ IDEA uses it by
default).

## License

[Apache License, Version 2.0](https://github.com/sdercolin/utaformatix3/blob/master/LICENSE.md)