Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ogihara88sai committed Jul 20, 2022
1 parent 9a61342 commit 4dc4694
Show file tree
Hide file tree
Showing 592 changed files with 121,500 additions and 2 deletions.
19 changes: 19 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
module.exports = {
env: {
browser: true,
commonjs: true,
es2021: true,
},
globals: {
TYRANO: true,
$: true,
jQuery: true,
anime: true,
html2canvas: true,
},
extends: ['eslint:recommended'],
parserOptions: {
ecmaVersion: 'latest',
},
rules: {},
}
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Thumbs.db
.DS_Store
*.log
node_modules/
dist/
package-lock.json
studio_config.json
__readme.txt
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
#lib
tyrano/libs/
12 changes: 12 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
module.exports = {
tabWidth: 2,
useTabs: false,
semi: false,
singleQuote: true,
quoteProps: 'consistent',
trailingComma: 'all',
arrowParens: 'always',
bracketSpacing: true,
endOfLine: 'lf',
printWidth: 100,
}
5 changes: 5 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"eslint.validate": ["javascript"]
}
182 changes: 180 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,180 @@
# tsp-ambient-light
ティラノスクリプト用プラグイン『環境光プラグイン』(ambient_light)の開発リポジトリ。
# 環境光プラグイン『ambient_light』

【名称】環境光プラグイン『ambient_light』
【種別】ティラノスクリプト用プラグイン
【開発環境】Windows 10 64bit OS
【製作者】荻原(おぎはら)
【連絡先】https://twitter.com/ogihara88sai
【バージョン】1.0.0
【最終更新日】2022.07.20 19:52:00
【ライセンス】MIT

Copyright (c) 2022 荻原
Released under the MIT license
https://opensource.org/licenses/mit-license.php

---

## 概要

![環境光プラグインのサンプル動画](./docs/example.webp)

キャラに環境光を当てて背景に溶け込ませることができるプラグインです。

`[bg]`タグに連動して自動で環境光が更新されます。(便利!)

基本的には、`first.ks``[plugin name="ambient_light"]`を書いてプラグインを読み込んで、`make.ks``[ambient_light_restore]`を追記するだけで機能します。

ただし、`[bg]`以外のタグにも連動させたい場合や環境光の手動調整をおこないたい場合にはひと手間必要です。この説明書やサンプルシナリオを活用してカスタマイズにチャレンジしてみてください。

バグ報告や機能要望については、Twitter の DM または GitHub の Issue にてお知らせくださいませ。

動作デモ:https://ogihara88sai.github.io/tsp-ambient-light/latest/

---

## ファイル構成

```
ambient_light
├ init.ks
├ main.js
├ __example.ks
└ __readme.txt
```

---

## 導入方法

zip ファイルを展開して出てきた`ambient_light`フォルダを
ティラノスクリプトのプロジェクトフォルダの`data/others/plugin/`下に配置してください。
その後`first.ks`等に以下のタグを記述してください。

```
[plugin name="ambient_light"]
```

ティラノスクリプトのバージョンが V514 以前(V514 を含む)の場合は、`make.ks`[return]よりも前に次のタグを追加してください。

```
[ambient_light_restore]
```

---

## 注意点

- CSS の filter プロパティを利用して環境光を当てているため、環境光の対象に[filter]タグを使ってフィルターをかけると環境光が無効化されます。

---

## 他プラグインとの競合

- [bg]タグの内部を直接書き変えるようなプラグインを環境光プラグインよりもあとに読み込むと、[bg]に連動した環境光の自動更新が機能しなくなります。

---

## プラグインを[plugin]タグで読む込むときに指定できるパラメータ

すべて省略しても動作します。

ただし、横幅サイズや高さサイズの大きなキャラ画像素材を使っている場合には width、height パラメータを指定してください。width、height を指定してあげないと画像が正常に表示されない場合があります。

デフォルトでは[bg]タグに連動して自動で環境光が更新されますが、[bg]以外の独自の背景変更タグ(たとえば[my_bg])にも連動させたい場合は、link パラメータを"bg, my_bg"のように指定してください。環境光が正常に更新されるようにするためには、連動させたいタグの storage パラメータに画像(bgimage 基準)が指定されている必要があります。

| パラメータ | 説明 |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| width | フィルタの横方向の適用範囲。基本的に省略してOKですが、1000px よりも横幅の大きいキャラ画像を使用している場合はそれに合わせた値を指定してください。 |
| height | フィルタの縦方向の適用範囲。基本的に省略してOKですが、2000px よりも高さの大きいキャラ画像を使用している場合はそれに合わせた値を指定してください。 |
| link | 環境光の更新を連動させるタグを指定します。デフォルトは"bg"で、これは[bg]タグによる背景変更に連動させて自動で環境光を更新していくことを意味します。たとえば[bg]だけでなく[bg2]にも連動させたい場合は"bg, bg2"のように指定してください。(カンマ区切り) |

---

## タグリファレンス

環境光プラグインを読み込むと、以下のタグが新しく使えるようになります。

- [ambient_light_config]
- [ambient_light]
- [ambient_light_def]
- [ambient_light_def_del]
- [ambient_light_restore]

### [ambient_light_config] 環境光の全般的な設定

環境光に関する全般的な設定をおこなうタグです。省略したパラメータについては設定の変更はおこなわれません。

環境光が強すぎると感じる場合は hard_light="false" がオススメです。

| パラメータ | 説明 |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| auto | [bg]タグなどに連動しておこなわれる環境光の自動更新を有効にするかどうか。初期値は`true``false`を指定すると環境光の自動更新をオフにできます。 |
| shadow | デフォルトで逆光を有効にするかどうか。初期値は`true``false`を指定すると無効になり、逆光が表示されなくなります。 |
| shadow_size | デフォルトの逆光のサイズ。初期値は`16`です。 |
| shadow_opacity | デフォルトの逆光の不透明度。`0.0 ~ 1.0`で指定します。初期値は`0.3`です。 |
| hard_light | ハードライトを有効にするかどうか。初期値は`true``false`を指定するとハードライトが無効になり、暗い背景のときでもキャラがあまり暗くならなくなります。 |
| name | 環境光をキャラ以外の画像にも適用したい場合に指定します。このタグを通過する時点で該当要素が表示されていなくても使用可能です。一度指定しておけば、その要素が永久に環境光適用対象になります。 |

### [ambient_light] 環境光の更新

環境光を手動で変更します。

storage パラメータに画像を指定するか、color パラメータに色を直接指定するかのどちらかによって環境光を変化させることができます。

name パラメータを指定することで現在画面上に出ているキャラ以外の要素に環境光を当てる機能もあります。

| パラメータ | 説明 |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| time | ミリ秒単位の数値を指定することでフェード処理できます。 |
| storage | 画像を使って環境光を更新したい場合に画像ファイルの場所を指定します。画像は bgimage から探します。 |
| color | 画像を使わずに環境光の色を直接指定したい場合にはこちらのパラメータを利用できます。`0xFFFFFF``#FFFFFF``rgb(255,255,255)`のどれかの形式で指定してください。`white`のようなカラーコードには対応しません。環境光なしにしたい場合は`none`と指定してください。 |
| mode | 合成方法を指定します。`soft-light``hard-light`がオススメ。`screen``multiply`なども使えます。 |
| shadow | 逆光を有効にするかどうか。`false`を指定すると無効になります。 |
| shadow_color | 逆光の色。 |
| shadow_size | 逆光のサイズ。デフォルトは`16`です。 |
| shadow_opacity | 逆光の不透明度。`0.0 ~ 1.0`で指定します。デフォルトは`0.3`です。 |
| name | 環境光をキャラ以外の画像にも適用したい場合に指定します。name 以外のパラメータは省略してOKです。 |

### [ambient_light_def] 特定画像の環境光の定義

特定の画像の環境光の色を直接定義することができます。storage パラメータと color パラメータが必須。

自動調整で決定される環境光がイマイチな場合はこちらのタグで定義してあげてください。一度定義すれば、その画像を背景に出したときには常にその環境光設定が使われるようになります。

このタグで定義した環境光を削除するには[ambient_light_def_del]タグを使用してください。

また、このタグで定義を環境光設定を"使い捨て"にする(1 回この定義を使ったら自動で定義を削除する)ようにするためには、once パラメータに true を指定してください。

| パラメータ | 説明 |
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| storage | 画像ファイルのパス。bgimage から探します。 |
| color | 環境光の色。`0xFFFFFF``#FFFFFF``rgb(255,255,255)`のどれかの形式で指定してください。`white`のようなカラーコードには対応しません。環境光なしにしたい場合は`none`と指定してください。 |
| mode | 合成方法を指定します。`soft-light``hard-light`がオススメ。`screen``multiply`なども使えます。 |
| shadow | 逆光を有効にするかどうか。`false`を指定すると無効になります。 |
| shadow_color | 逆光の色。 |
| shadow_size | 逆光のサイズ。デフォルトは`16`です。 |
| shadow_opacity | 逆光の不透明度。`0.0 ~ 1.0`で指定します。デフォルトは`0.3`です。 |
| once | `true`を指定しておくと、この定義を1回こっきりの使い捨て定義にできます。[ambient_light_def_del]を書く手間を省けます。 |

### [ambient_light_def_del] 環境光の設定

[ambient_light]で定義した環境光の設定を削除します。

| パラメータ | 説明 |
| ---------- | ------------------------------------- |
| storage | 定義を削除する storage を指定します。 |

### [ambient_light_restore] 環境光の復元

セーブ時の環境光を復元するために、`make.ks`にこのタグを記述する必要があります。

指定できるパラメータはありません。

---

## 更新履歴

### v1.0.0

公開。
Binary file added docs/example.mp4
Binary file not shown.
Binary file added docs/example.webp
Binary file not shown.
Binary file added docs/latest/data/bgimage/eki1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/eki2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/eki3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/eki4.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/room.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/rouka.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/title.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/umi1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/umi2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgimage/umi3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/bgm/music.m4a
Binary file not shown.
Binary file added docs/latest/data/bgm/music.ogg
Binary file not shown.
Binary file added docs/latest/data/fgimage/builder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/akane/angry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/akane/doki.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/akane/happy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/akane/normal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/akane/sad.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/yamato/angry.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/yamato/happy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/yamato/normal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/yamato/sad.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/fgimage/chara/yamato/tohoho.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/image/ExQuestion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/image/button/auto.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/image/button/auto2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/image/button/close.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/latest/data/image/button/close2.png
Binary file added docs/latest/data/image/button/load.png
Binary file added docs/latest/data/image/button/load2.png
Binary file added docs/latest/data/image/button/log.png
Binary file added docs/latest/data/image/button/log2.png
Binary file added docs/latest/data/image/button/menu.png
Binary file added docs/latest/data/image/button/menu2.png
Binary file added docs/latest/data/image/button/qload.png
Binary file added docs/latest/data/image/button/qload2.png
Binary file added docs/latest/data/image/button/qsave.png
Binary file added docs/latest/data/image/button/qsave2.png
Binary file added docs/latest/data/image/button/save.png
Binary file added docs/latest/data/image/button/save2.png
Binary file added docs/latest/data/image/button/screen.png
Binary file added docs/latest/data/image/button/screen2.png
Binary file added docs/latest/data/image/button/skip.png
Binary file added docs/latest/data/image/button/skip2.png
Binary file added docs/latest/data/image/button/sleep.png
Binary file added docs/latest/data/image/button/sleep2.png
Binary file added docs/latest/data/image/button/title.png
Binary file added docs/latest/data/image/button/title2.png
Binary file added docs/latest/data/image/config/arrow_next.png
Binary file added docs/latest/data/image/config/arrow_prev.png
Binary file added docs/latest/data/image/config/bg_config.jpg
Binary file added docs/latest/data/image/config/bg_config.png
Binary file added docs/latest/data/image/config/c_btn.gif
Binary file added docs/latest/data/image/config/c_btn.png
Binary file added docs/latest/data/image/config/c_btn_back.png
Binary file added docs/latest/data/image/config/c_btn_back2.png
Binary file added docs/latest/data/image/config/c_set.png
Binary file added docs/latest/data/image/config/c_skipoff.png
Binary file added docs/latest/data/image/config/c_skipon.png
Binary file added docs/latest/data/image/config/c_uts_off.png
Binary file added docs/latest/data/image/config/c_uts_on.png
Binary file added docs/latest/data/image/config/label_cg.png
Binary file added docs/latest/data/image/config/label_config.png
Binary file added docs/latest/data/image/config/message_box.png
Binary file added docs/latest/data/image/frame.png
Binary file added docs/latest/data/image/title/button_cg.png
Binary file added docs/latest/data/image/title/button_cg2.png
Binary file added docs/latest/data/image/title/button_cg3.png
Binary file added docs/latest/data/image/title/button_config.png
Binary file added docs/latest/data/image/title/button_config2.png
Binary file added docs/latest/data/image/title/button_config3.png
Binary file added docs/latest/data/image/title/button_load.png
Binary file added docs/latest/data/image/title/button_load2.png
Binary file added docs/latest/data/image/title/button_load3.png
Binary file added docs/latest/data/image/title/button_replay.png
Binary file added docs/latest/data/image/title/button_replay2.png
Binary file added docs/latest/data/image/title/button_replay3.png
Binary file added docs/latest/data/image/title/button_start.png
Binary file added docs/latest/data/image/title/button_start2.png
Binary file added docs/latest/data/image/title/button_start3.png
114 changes: 114 additions & 0 deletions docs/latest/data/others/plugin/ambient_light/__example.ks
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@

;プラグイン読み込み!
;[bg]タグに連動して環境光を変えるよ
[plugin name="ambient_light" link="bg"]


;このあたりはプラグインに直接関係のないメッセージウィンドウ設定やキャラ定義です
;デフォルトプロジェクトの素材+きまぐれアフターさんの背景素材を使っています
[position left="160" top="500" width="1000" height="200"]
[position margint="45" marginl="50" marginr="70" marginb="60"]
[ptext name="chara_name_area" layer="message0" color="white" size="28" bold="true" x="180" y="510" shadow="black"]
[chara_config ptext="chara_name_area"]
[bg storage="umi1.jpg" time="0"]
[chara_new name="akane" storage="chara/akane/normal.png" jname="あかね"]
[chara_new name="yamato" storage="chara/yamato/normal.png" jname="やまと"]
[chara_face name="akane" face="angry" storage="chara/akane/angry.png"]
[chara_face name="akane" face="doki" storage="chara/akane/doki.png"]
[chara_face name="akane" face="happy" storage="chara/akane/happy.png"]
[chara_face name="akane" face="sad" storage="chara/akane/sad.png"]
[image name="dummy" layer="0" storage="../fgimage/chara/akane/normal.png" x="900" y="120"]
[ptext layer="0" color="white" size="28" bold="true" x="1070" y="100" text="比較用" edge="4px black"]
[chara_show name="akane" time="100"]
[chara_show name="yamato" time="100"]
[deffont bold="true" shadow="black"]
[resetfont]


*start

#akane
夕方の海に移動するよ[p]

[bg storage="umi2.jpg" time="800"]

#akane:happy
つぎは夜の海に移動するよ[p]

[bg storage="umi3.jpg" time="800"]

#akane:default
つぎは昼の駅前に移動するよ[p]

[bg storage="eki1.jpg" time="800"]

つぎは夕方の駅前に移動するよ[p]

[bg storage="eki2.jpg" time="800"]

つぎは夜の駅前に移動するよ[p]

[bg storage="eki3.jpg" time="800"]

つぎは深夜の駅前に移動するよ[p]

[bg storage="eki4.jpg" time="800"]

つぎは逆光をオフにするよ[p]

[ambient_light shadow_opacity="0" time="800"]

つぎは環境光をオフにするよ[p]

[ambient_light color="none" time="800"]

つぎは環境光を赤くするよ[p]

[ambient_light color="#ffbbbb" time="800"]

「eki3.jpg」の環境光を直接定義するよ(自動環境光調整が行われなくなるよ)[p]

[ambient_light_def storage="eki3.jpg" color="rgb(50, 50, 100)"]
[bg storage="eki3.jpg" time="800"]

自動調整のときより青っぽくなったね[p]

[bg storage="eki2.jpg" time="800"]
[bg storage="eki3.jpg" time="800"]

以後、この指定した色が使われるようになるよ[p]
さっきの「eki3.jpg」の環境光定義を削除して、また自動調整を有効にするよ[p]

[ambient_light_def_del storage="eki3.jpg"]
[bg storage="eki3.jpg" time="800"]

キャラ以外の画像にも環境光を適用できるよ[p]

[ambient_light name="dummy"]

ほら[p]
でも、これだと1回消してもう1度表示したときにはもとに戻る[p]

[free layer="0" name="dummy" time="500" wait="true"]
[image name="dummy" layer="0" storage="../fgimage/chara/akane/normal.png" x="900" y="120" time="500" wait="true"]

ほら[p]
でも、ambient_light_configで指定しておけば、出し入れしても固定で環境光が当たり続けるよ[p]

[ambient_light_config name="dummy"]

[free layer="0" name="dummy" time="500" wait="true"]
[image name="dummy" layer="0" storage="../fgimage/chara/akane/normal.png" x="900" y="120" time="500" wait="true"]

[free layer="0" name="dummy" time="500" wait="true"]
[image name="dummy" layer="0" storage="../fgimage/chara/akane/normal.png" x="900" y="120" time="500" wait="true"]

#akane:happy
ね[p]

#akane:default
ハードライトを無効にして最初に戻るね[p]

[ambient_light_config hard_light="false"]

[jump target="start"]
2 changes: 2 additions & 0 deletions docs/latest/data/others/plugin/ambient_light/init.ks
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[loadjs storage="plugin/ambient_light/main.js"]
[return]
Loading

0 comments on commit 4dc4694

Please sign in to comment.