# CytoidSchemas

**Repository Path**: ZeroAurora233/CytoidSchemas

## Basic Information

- **Project Name**: CytoidSchemas
- **Description**: 为音乐游戏 Cytoid 的各个 JSON 文件写就的 JSON Schema
- **Primary Language**: Unknown
- **License**: CC0-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-09-30
- **Last Updated**: 2024-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Schemas

Community-maintained schemas for Cytoid-related JSON files

## How to use

1. Use a [compatible editor](https://json-schema.org/implementations.html#editors). Visual Studio Code is recommended.
2. Add a line to the head of your JSON file:

```json
{
  "$schema": "https://url/to/schema",
  "other_things": "go_here"
}
```

3. Enjoy the auto-completion!

> Well not really. What JSON Schema can provide is actually very restricted. If you use a better tool, continue using it! This schema is to help you to write correct Cytoid-specific JSON files by hand.

## Releases

**NOTE: Minimal version is preferred. It has smaller file size and makes computers smile.**

### level.json

| Version     | GitHub                                                                                                                                                      | Gitee (mirror)                                                                                                                                                    |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 2.0 (Draft) | [raw](https://github.com/CytoidCommunity/Schemas/raw/master/2.0/level.json) [min](https://github.com/CytoidCommunity/Schemas/raw/master/min/2.0/level.json) | [raw](https://gitee.com/ZeroAurora233/CytoidSchemas/raw/master/2.0/level.json) [min](https://gitee.com/ZeroAurora233/CytoidSchemas/raw/master/min/2.0/level.json) |

### storyboard.json

| Version     | GitHub                                                                                                                                                                | Gitee (mirror)                                                                                                                                                              |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 2.0 (Draft) | [raw](https://github.com/CytoidCommunity/Schemas/raw/master/2.0/storyboard.json) [min](https://github.com/CytoidCommunity/Schemas/raw/master/min/2.0/storyboard.json) | [raw](https://gitee.com/ZeroAurora233/CytoidSchemas/raw/master/2.0/storyboard.json) [min](https://gitee.com/ZeroAurora233/CytoidSchemas/raw/master/min/2.0/storyboard.json) |

## To-Dos

- [ ] Complete the schemas.
- [ ] Complete integrated documentation, default values and more.
- [x] Style the schemas using `Prettier` rather than the formatter included in Visual Studio Code.
- [ ] Publish the first release!
- [ ] Implement JSON Schema draft 2019-09 (after Visual Studio Code fully supports it).

## License

For your convenience, the schemas are in **public domain**, under CC0-1.0. However, we still hope you to credit us in the description of your level!