Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nlkomaru authored Mar 26, 2022
1 parent f90cc09 commit 49e5772
Showing 1 changed file with 3 additions and 164 deletions.
167 changes: 3 additions & 164 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,172 +15,11 @@ copyコマンドを使用すると賭けられたデータ、sheetId、スタッ

命名規則 : `<レースの名前>_<回数>`

## Commands

### Audience
`/ra audience join <raceId>` 観客に自分を追加します <br>
permission: `RaceAssist.commands.audience.join`<br>

`/ra audience leave <raceId>` 観客から自分を削除します <br>
permission: `RaceAssist.commands.audience.leave`<br>

`/ra audience list <raceId>` 観客の一覧を表示 <br>
permission: `RaceAssist.commands.audience.list`<br>

### Bet

`/ra bet can <raceId> on/off` 対象のレースに対して賭けが可能か変更します <br>
permission: `RaceAssist.commands.bet.can`<br>

`/ra bet delete <raceId>` 賭けを削除します <br>
permission: `RaceAssist.commands.bet.delete`<br>

`/ra bet list <raceId>` 賭けの一覧を表示します <br>
permission: `RaceAssist.commands.bet.list`<br>

`/ra bet open <raceId>` 賭けをすることのできる画面を開くことができます <br>
permission: `RaceAssist.commands.bet.open`<br>

`/ra bet rate <raceId>` 賭けのレートを変更します <br>
permission: `RaceAssist.commands.bet.rate`<br>

`/ra bet revert <raceId>` すべての人に返金します <br>
permission: `RaceAssist.commands.bet.revert`<br>

`/ra bet return <raceId> <playerName>` 指定したプレイヤーにかけている人に支払いをします <br>
permission: `RaceAssist.commands.bet.return`<br>

`/ra bet remove <raceId> <betRow>` 指定した番号の賭けを返金 <br>
permission: `RaceAssist.commands.bet.remove`<br>

`/ra bet sheet <raceId> <SheetID>` spreadsheetを登録します<br>
permission: `RaceAssist.commands.bet.sheet`<br>
`https://docs.google.com/spreadsheets/d/***********/edit#gid=0` *****の部分をSheetIDに入力

### Place

`/ra place reverse <raceId>` レースの走行方向の向きを反転 <br>
permission: `RaceAssist.commands.place.reverse`<br>

`/ra place central <raceId>` レースの中心点を設定 <br>
permission: `RaceAssist.commands.place.central`<br>

`/ra place degree <raceId>` レースのゴールの角度を設定(立っている場所基準90度刻み) <br>
permission: `RaceAssist.commands.place.degree`<br>

`/ra place lap <raceId> <lap>` レースのラップ数を指定 <br>
permission: `RaceAssist.commands.place.lap`<br>

`/ra place set <raceId> in|out` レース場の内周、外周を指定 <br>
permission: `RaceAssist.commands.place.set`<br>

`/ra place finish` 上記の設定の終了 <br>
permission: `RaceAssist.commands.place.finish`<br>

### Player

`/ra player add <raceId> <Player>` 騎手を追加 <br>
permission: `RaceAssist.commands.player.add`<br>

`/ra player remove <raceId>` 騎手を削除 <br>
permission: `RaceAssist.commands.player.remove`<br>

`/ra player delete <raceId>` 騎手をすべて削除 <br>
permission: `RaceAssist.commands.player.delete`<br>

`/ra player list <raceId>` 騎手の一覧を表示 <br>
permission: `RaceAssist.commands.player.list`<br>

### Race

`/ra race start <raceId>` レースを開始 <br>
permission: `RaceAssist.commands.race.start`<br>

`/ra race debug <raceId>` レースのデバッグ <br>
permission: `RaceAssist.commands.race.debug`<br>

`/ra race stop <raceId>` レースの停止 <br>
permission: `RaceAssist.commands.race.stop`<br>

### Setting
`/ra setting create <raceId>` レースの作成 <br>
permission: `RaceAssist.commands.setting.create`<br>

`/ra setting delete <raceId>` レースの削除 <br>
permission: `RaceAssist.commands.setting.delete`<br>

`/ra setting copy <raceId_1> <raceId_2>` レース1のsheetId、賭けリスト以外をすべてコピーします <br>
permission: `RaceAssist.commands.setting.copy`<br>

#### staff
`/ra setting staff add <raceId> <Player>` スタッフを追加します <br>
`/ra setting staff remove <raceId> <Player>` スタッフを削除します <br>
`/ra setting staff lista <raceId> <Player>` スタッフを表示します <br>
permission: `RaceAssist.commands.setting.staff`<br>

## permission

### 一般プレイヤー

`RaceAssist.user`


### レース作成者

`RaceAssist.commands.*`

## Usage

### Race
creator :`/ra setting create <raceId>`<br>
creator :`/ra place set <raceId> in`<br>
creator :`/ra place finish`<br>
creator :`/ra place set <raceId> out`<br>
creator :`/ra place finish`<br>
creator :`/ra place degree <raceId>`<br>
creator :`/ra place central <raceId>`<br>
creator :`/ra place reverse <raceId>` optional<br>
creator :`/ra player add <raceId> <Player>`<br>
audience :`/ra audience join <raceId>` <br>
creator :`/ra race start <raceId>`<br>

### Bet
creator :`/ra bet rate <raceId>`<br>
creator :`/ra bet sheet <raceId> <SheetID>` optional<br>
creator :`/ra bet can <raceId> on` <br>
player :`/ra bet open <raceId>`<br>
creator :`/ra bet can <raceId> off`<br>
race start<br>
creator :Pay manually<br>
creator :`/ra bet delete <raceId>`<br>

## About use sheets API

pluginフォルダの中のRaceAssistフォルダに**credentials.json**を入れます 最初の賭けが行われるとコンソールにOAuthの認証画面が開かれるのでスプレッドシートの所有者が認証してください

### credentials.jsonの設定

基本はAPIのダウンロードしたものにclient_secretを追加し、redirect_urlsのlocalhostを自分のドメイン(IP)に置き換える
[issue](https://github.com/Nlkomaru/RaceAssist-core/issues/6)

```json
{
"installed": {
"client_id": "******.apps.googleusercontent.com",
"project_id": "******",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://oauth2.googleapis.com/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_secret": "******",
"redirect_uris": [
"urn:ietf:wg:oauth:2.0:oob",
"http://localhost"
]
}
}
```

## translate
plugins/RaceAssist/Lang内に翻訳されたpropertiesファイルを入れるとその言語を使用している場合はその言語が表示されます。 <br>
標準ではja_JPを使用します。

[crowdin](https://crowdin.com/project/raceassist)<br>
`de_DE` : translate by DeepL API<br>
`en_US` : translate by DeepL API<br>
Expand Down

0 comments on commit 49e5772

Please sign in to comment.