Metadata-Version: 2.1
Name: pjsekai.scores
Version: 0.1.9
Summary: Render Project Sekai score files (sus) to images (svg). 
Author-email: Amaoto <amaoto@pjsekai.moe>
License: MIT License
        
        Copyright (c) 2023 pjsekai.moe
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://gitlab.com/pjsekai/scores
Project-URL: Documentation, https://gitlab.com/pjsekai/scores/-/wikis
Project-URL: Bug Tracker, https://gitlab.com/pjsekai/scores/-/issues
Keywords: Project Sekai,pjsekai,SUS
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: svgwrite

# Project Sekai Scores

プロセカの譜面ファイル解析し、ベクトル画像（SVG）を生成する。

## Installation

pip でインストール：

```
pip install pjsekai.scores
```

また、手動でビルドしてインストール：

```
python -m build
pip install dist/pjsekai.scores-*.whl
```

## Usage

Project Sekai Scores には、デフォルトの起動スクリプトが含まれており、ローカルの SUS 譜面ファイルを読み込み、それを SVG ベクター画像に変換することができます。以下のコマンドを使って簡単に実行できます：

```
python -m pjsekai.scores <xxx.sus>
```

以下はパッケージとして使用して譜面画像を生成する例です：

```python
import pjsekai.scores

score = pjsekai.scores.Score.open('1.sus', encoding='UTF-8')
drawing = pjsekai.scores.Drawing(score=score)
drawing.svg().saveas('1.svg')
```

譜面ファイルを個性化して豊かにするカスタマイズ機能を提供しています。下記の文書をご参照ください：

* [BPM、拍子、セクションを変換](https://gitlab.com/pjsekai/scores/-/wikis/rebase)

* [歌詞を追加](https://gitlab.com/pjsekai/scores/-/wikis/lyric)

* [スタイルシートをカスタマイズ](https://gitlab.com/pjsekai/scores/-/wikis/css)

## License

Project Sekai Scores は MIT ライセンスのもとで提供されています。詳細については、[LICENSE](LICENSE) ファイルをご覧ください。

Project Sekai Scores は SEGA・Colorful Palette・プロジェクトセカイとは一切関係がありません。
