Skip to content

Commit

Permalink
ドキュメントを整備。
Browse files Browse the repository at this point in the history
  • Loading branch information
TanaUmbreon committed Jun 6, 2022
1 parent d6f0250 commit d393af7
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 23 deletions.
12 changes: 12 additions & 0 deletions MEMO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# 開発用メモ

## フォルダ構成

- `\`
- `NormalInvitation\` : LOR Invitation Editorで作成したフォルダー。XMLデータの編集兼ワークショップリリース用として使用する。
- `Assemblies\` : MODのDLLを配置するフォルダー。ソースコードをReleaseビルドした場合、このフォルダーに出力するようにしている。
- `Data\`
- `Resource\`
- `Src\` : MODのソースコードを置いたフォルダー。
- `Assemblies\` : ソースコードをビルドするために、C#プロジェクトから外部参照するDLLを配置しているフォルダー(例えば、MOD開発に必須なゲーム本体の `Assembly-CSharp.dll` ファイルなどはここに配置されたものをC#プロジェクトから参照している)。GitHubでの公開が前提なので、オープンソースでないDLLはバージョン管理対象にしていない。個別でコピペして用意する必要がある。
- `BookDropRateChanger\` : MOD本体のC#プロジェクトフォルダー。
26 changes: 3 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,16 @@

敵が落とす本の数を増減させるチート系MODです。

既定では2倍の数の本を落とすようになりますが、この倍率はユーザー側で任意にカスタマイズすることができます
既定では2倍の数の本を落とすようになりますが、この倍率はユーザー側で任意にカスタマイズすることもできます

## 注意事項・免責事項等

- **このMODの使用により発生した問題等は、いかなる理由があっても一切責任を負いません。**
- ゲームバランスを著しく変えてしまうリスクがあります。
- 効果の程度をカスタマイズするには、JSON形式のテキストファイルを直接編集する必要があります。

## 効果の程度のカスタマイズ方法

1. 一度ゲームを起動して当MODをロードしてください。
2. ロードを行うとワークショップのインストール先に `ModSettings.json` という設定ファイルが作成されます。
3. この設定ファイルをメモ帳など任意のテキストエディターで開きます。
4. 落とす本の数の倍率を書き換えます。
5. 設定ファイルを上書き保存します。
6. ゲームに即時反映されます。※ゲーム起動中でもリアルタイムで適用されます。

落とす本の倍率は、具体的には「0.0~10.0」の倍率を指定することで落とす本の数を増やしたり減らしたりすることができます。減らす場合、落とす本の数が1冊を下回ることはありません。

## ダウンロード・リリースノート

「Releases」ページ ~~を参照してください。~~ の準備はまだですわよ。

## フォルダ構成
最新バージョンは [Steam ワークショップ](https://steamcommunity.com/sharedfiles/filedetails/?id=2817764906) からダウンロードできます。

- `\`
- `NormalInvitation\` : LOR Invitation Editorで作成したフォルダーです。XMLデータの編集兼ワークショップリリース用として使用します。
- `Assemblies\` : MODのDLLを配置するフォルダーです。ソースコードをReleaseビルドした場合、このフォルダーにDLLが出力されます。
- `Data\`
- `Resource\`
- `Src\` : MODのソースコードを置いたフォルダーです。
- `Assemblies\` : ソースコードをビルドするために、C#プロジェクトから外部参照するDLLを配置しているフォルダーです(例えば、MOD開発に必須なゲーム本体の `Assembly-CSharp.dll` ファイルなどはここに配置されたものをC#プロジェクトから参照しています)。オープンソースでないDLLはバージョン管理対象にしていないので、個別でコピペして用意する必要があります。
- `BookDropRateChanger\` : MOD本体のC#プロジェクトフォルダーです。
古いバージョンやリリースノート、ソースコードのアーカイブは [「Releases」ページ](https://github.com/TanaUmbreon/RuinaBookDropRateChanger/releases) を参照してください。

0 comments on commit d393af7

Please sign in to comment.