Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xfl03/sekai-calculator
Project SEKAI Calculator for deck power, live score, event point and more.
https://github.com/xfl03/sekai-calculator
Last synced: 2 months ago
JSON representation
Project SEKAI Calculator for deck power, live score, event point and more.
- Host: GitHub
- URL: https://github.com/xfl03/sekai-calculator
- Owner: xfl03
- License: lgpl-2.1
- Created: 2023-03-13T18:03:27.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-13T11:49:46.000Z (about 1 year ago)
- Last Synced: 2024-04-14T04:19:16.891Z (9 months ago)
- Language: TypeScript
- Size: 333 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sekai-calculator
Project SEKAI Calculator for deck power, live score, event point and more.
Moreover, it can recommend deck and music to get higher score or event point.This project is fully developed with TypeScript, while reducing `any` as possible.
Both ECMAScript Module `index.mjs` and CommonJS `index.cjs` are provided with types `index.d.ts` for TypeScript.
## Quick Start
### Install
This package has been released in [npm](https://www.npmjs.com/package/sekai-calculator).
```shell
# npm
npm i sekai-calculator
# yarn
yarn add sekai-calculator
# pnpm
pnpm add sekai-calculator
```
### Usage
Example is written in TypeScript.A `DataProvider` implementation is required for providing `UserData`, `MasterData` and `MusicMeta`.
Basically, `UserArea`, `UserCard`, `UserCharacter` and `UserHonor` are required in `UserData`.
```typescript
// W.I.P.
```## Development
### Release
```shell
pnpm release
```