initial upload

nishlumi · Apr 6, 2022 · bed0776 · bed0776
1 parent 63df755
commit bed0776
Show file tree

Hide file tree

Showing 90 changed files with 130,534 additions and 70 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,19 @@
+myst-parser==0.17.0
+Sphinx==4.2.0
+sphinx-rtd-theme==1.0.0
+sphinxcontrib-applehelp @ file:///home/ktietz/src/ci/sphinxcontrib-applehelp_1611920841464/work
+sphinxcontrib-blockdiag==3.0.0
+sphinxcontrib-devhelp @ file:///home/ktietz/src/ci/sphinxcontrib-devhelp_1611920923094/work
+sphinxcontrib-htmlhelp @ file:///tmp/build/80754af9/sphinxcontrib-htmlhelp_1623945626792/work
+sphinxcontrib-jsmath @ file:///home/ktietz/src/ci/sphinxcontrib-jsmath_1611920942228/work
+sphinxcontrib-mermaid==0.7.1
+sphinxcontrib-pandoc-markdown==1.6.8
+sphinxcontrib-qthelp @ file:///home/ktietz/src/ci/sphinxcontrib-qthelp_1611921055322/work
+sphinxcontrib-seqdiag==3.0.0
+sphinxcontrib-serializinghtml @ file:///tmp/build/80754af9/sphinxcontrib-serializinghtml_1624451540180/work
+sphinxcontrib-websupport @ file:///tmp/build/80754af9/sphinxcontrib-websupport_1597081412696/work
+sphinxjp.themecore==0.2.0
+sphinxjp.themes.trstyle==0.1.1
+blockdiag==3.0.0
+seqdiag==3.0.0
+Pillow==8.4.0
diff --git a/docs/source/_static/css/mytheme.css b/docs/source/_static/css/mytheme.css
@@ -0,0 +1,30 @@
+@import url("theme.css");
+
+.wy-nav-content {
+    max-width: none;
+}
+
+h1 {
+    border-bottom: 4x solid #ccc;
+}
+h2 {
+    border-bottom: 3px solid #ccc;
+}
+h3 {
+    border-bottom: 2px solid #ccc;
+}
+h4,h5,h6 {
+    border-bottom: 1px solid #ccc;
+}
+
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: normal;
+}
+
+colgroup {
+    display: none;
+}
+
+ul.simple li {
+    margin-bottom : 0.75rem;
+}
diff --git a/docs/source/_static/js/mermaid.js b/docs/source/_static/js/mermaid.js
diff --git a/docs/source/api.rst b/docs/source/api.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,35 +1,90 @@
 # Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# -- Project information
+# -- Path setup --------------------------------------------------------------
 
-project = 'Lumache'
-copyright = '2021, Graziella'
-author = 'Graziella'
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
 
-release = '0.1'
-version = '0.1.0'
 
-# -- General configuration
+# -- Project information -----------------------------------------------------
 
+project = 'VRMViewMeister'
+copyright = '2022, ISHII Eiju'
+author = 'ISHII Eiju'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
 extensions = [
     'sphinx.ext.duration',
     'sphinx.ext.doctest',
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    "myst_parser",
+    "sphinxcontrib.mermaid"
 ]
+html_js_files = [
+    "js/mermaid.js",
+]
+mermaid_params = ['--theme', 'forest', '--width', '600', '--backgroundColor', 'transparent']
 
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
-}
-intersphinx_disabled_domains = ['std']
+html_style = "css/mytheme.css"
+
+# LaTeX の docclass 設定
+latex_docclass = {'manual': 'jsbook'}
 
+# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-# -- Options for HTML output
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'ja'
 
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+source_suffix = [".rst",".md"]
+source_parsers = {
+    ".rst" : "restructuredtext",
+    ".md": 'markdown',
+    ".txt": 'markdown'
+}
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+# sphinx_rtd_theme trstyle alabaster classic sphinxdoc scrolls agogo traditional nature haiku pyramid bizstyle
 html_theme = 'sphinx_rtd_theme'
 
+#sphinx_rtd_theme
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
 # -- Options for EPUB output
 epub_show_urls = 'footnote'
diff --git a/docs/source/img/app_og_image.png b/docs/source/img/app_og_image.png
diff --git a/docs/source/img/install01.png b/docs/source/img/install01.png
diff --git a/docs/source/img/install02.png b/docs/source/img/install02.png
diff --git a/docs/source/img/install03.png b/docs/source/img/install03.png
diff --git a/docs/source/img/install04.png b/docs/source/img/install04.png
diff --git a/docs/source/img/install05.png b/docs/source/img/install05.png
diff --git a/docs/source/img/operation_vrm_1.png b/docs/source/img/operation_vrm_1.png
diff --git a/docs/source/img/prop_common_1.png b/docs/source/img/prop_common_1.png
diff --git a/docs/source/img/prop_common_2.png b/docs/source/img/prop_common_2.png
diff --git a/docs/source/img/prop_common_3.png b/docs/source/img/prop_common_3.png
diff --git a/docs/source/img/prop_common_4.png b/docs/source/img/prop_common_4.png
diff --git a/docs/source/img/prop_vrm_1.png b/docs/source/img/prop_vrm_1.png
diff --git a/docs/source/img/prop_vrm_2.png b/docs/source/img/prop_vrm_2.png
diff --git a/docs/source/img/prop_vrm_3.png b/docs/source/img/prop_vrm_3.png
diff --git a/docs/source/img/prop_vrm_4.png b/docs/source/img/prop_vrm_4.png
diff --git a/docs/source/img/screen_appconfig.png b/docs/source/img/screen_appconfig.png
diff --git a/docs/source/img/screen_contextmenu.png b/docs/source/img/screen_contextmenu.png
diff --git a/docs/source/img/screen_gravity.png b/docs/source/img/screen_gravity.png
diff --git a/docs/source/img/screen_ikmarker.png b/docs/source/img/screen_ikmarker.png
diff --git a/docs/source/img/screen_keyframe.png b/docs/source/img/screen_keyframe.png
diff --git a/docs/source/img/screen_main.png b/docs/source/img/screen_main.png
diff --git a/docs/source/img/screen_mediapipe.png b/docs/source/img/screen_mediapipe.png
diff --git a/docs/source/img/screen_objlist.png b/docs/source/img/screen_objlist.png
diff --git a/docs/source/img/screen_pose.png b/docs/source/img/screen_pose.png
diff --git a/docs/source/img/screen_project.png b/docs/source/img/screen_project.png
diff --git a/docs/source/img/screen_prop.png b/docs/source/img/screen_prop.png
diff --git a/docs/source/img/screen_ribbon_animation.png b/docs/source/img/screen_ribbon_animation.png
diff --git a/docs/source/img/screen_ribbon_audio.png b/docs/source/img/screen_ribbon_audio.png
diff --git a/docs/source/img/screen_ribbon_home.png b/docs/source/img/screen_ribbon_home.png
diff --git a/docs/source/img/screen_ribbon_model.png b/docs/source/img/screen_ribbon_model.png
diff --git a/docs/source/img/screen_ribbon_scr.png b/docs/source/img/screen_ribbon_scr.png
diff --git a/docs/source/img/screen_ribbon_syseff.png b/docs/source/img/screen_ribbon_syseff.png
diff --git a/docs/source/img/screen_scrshot.png b/docs/source/img/screen_scrshot.png
diff --git a/docs/source/img/screen_storagedlg.png b/docs/source/img/screen_storagedlg.png
diff --git a/docs/source/img/screen_timeline.png b/docs/source/img/screen_timeline.png
diff --git a/docs/source/img/screen_videoplayer.png b/docs/source/img/screen_videoplayer.png
diff --git a/docs/source/img/screen_vpad.png b/docs/source/img/screen_vpad.png
diff --git a/docs/source/img/screen_vpad_1.png b/docs/source/img/screen_vpad_1.png
diff --git a/docs/source/img/screen_vpad_2.png b/docs/source/img/screen_vpad_2.png
diff --git a/docs/source/img/screen_vrminfo.png b/docs/source/img/screen_vrminfo.png
diff --git a/docs/source/img/screen_vrminfo_1.png b/docs/source/img/screen_vrminfo_1.png
diff --git a/docs/source/img/screen_vrminfo_2.png b/docs/source/img/screen_vrminfo_2.png
diff --git a/docs/source/img/screen_webgl.png b/docs/source/img/screen_webgl.png
diff --git a/docs/source/img/uninstall01.png b/docs/source/img/uninstall01.png
diff --git a/docs/source/img/uninstall02.png b/docs/source/img/uninstall02.png
diff --git a/docs/source/img/uninstall03.png b/docs/source/img/uninstall03.png
diff --git a/docs/source/img/uninstall04.png b/docs/source/img/uninstall04.png
diff --git a/docs/source/img/uninstall05.png b/docs/source/img/uninstall05.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,22 +1,39 @@
-Welcome to Lumache's documentation!
-===================================
+.. VRMViewMeister documentation master file, created by
+   sphinx-quickstart on Tue Apr  5 20:38:26 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
 
-**Lumache** (/lu'make/) is a Python library for cooks and food lovers
-that creates recipes mixing random ingredients.
-It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/>`_
-and offers a *simple* and *intuitive* API.
+Welcome to VRMViewMeister's documentation!
+==========================================
 
-Check out the :doc:`usage` section for further information, including
-how to :ref:`installation` the project.
+.. image:: img/app_og_image.png
+   :align: center
 
-.. note::
 
-   This project is under active development.
 
-Contents
---------
+ウェブアプリでできる、VRoid(VRM)のポーズ・アニメーション！
+---------------------------------------------------------------
+
 
 .. toctree::
+   :maxdepth: 2
+   :caption: 目次:
+   :numbered:
+
+   man1/initial
+   man1/environ
+   man1/aboutuse
+   man1/install
+   man1/feature
+
+   man1/screen
+
+   man2/object_about
+   man2/property
+
+索引と検索
+==================
 
-   usage
-   api
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/man1/aboutuse.rst b/docs/source/man1/aboutuse.rst
@@ -0,0 +1,20 @@
+###############
+利用の前提条件
+###############
+
+
+　本アプリは無料で利用できます。ウェブアプリにしばしばある **ユーザー登録は不要** です。
+　私自身、無料・すぐ使える！などとと謳っておきながら利用のためにいちいち
+ユーザー登録が必要だったりするウェブアプリが嫌いなため、本アプリでは
+スマホアプリやPCソフトのように、アクセスしたら本当にすぐ利用できることを
+目指しました。
+
+※ウェブアプリ版は動作するサーバ次第で動作遅延がありえます。また当然ですが
+インターネット接続が必要です。通信のない環境で安定して使いたい方は後述のスタンドアロン版のご利用をお勧めします。
+
+※本アプリを公開・リンクしているウェブサイト「VRoid鎮守府ポータル」は
+アクセス人数把握のため、Googleアナリティクスを利用しております。
+ご了承ください。
+
+　本アプリ自体にはユーザー情報をサーバ上で管理したり外部サービスに
+アクセスしてデータをやり取りする機能を一切持っていません。
diff --git a/docs/source/man1/environ.rst b/docs/source/man1/environ.rst
@@ -0,0 +1,51 @@
+#######################
+動作環境
+#######################
+
+
+.. list-table:: 
+    :header-rows: 1
+
+    * - 種類
+      - 内容
+    * - OS 
+      - | Windows, macOS, Linux, ChromeOS※
+        | ※Android, iOSは使えないこともありませんが非推奨です
+        | ※スタンドアロン版はChromeOSでは使えません。
+    * - 対応ブラウザ
+      - | Edge, Chrome, Opera, Vivaldi, (Firefox)
+        | ※FirefoxはPWAの独立したウィンドウ化を行なえません。
+    * - 通信量
+      - | 初回・・・最大約90～150MB
+        | アップデート直後・・・1KB～90MB
+        | 2回目以降の通常・・・約1～100KB程度
+    * - メモリ
+      - | 推奨設定は512MB
+        | ※アプリ内で256MB～4GBの範囲で使用量の調整が可能です
+        | ※開発PCは8GBで開発しております 
+    * - ビデオカード
+      - GTX 1060搭載のPCにて確認
+    * - 外部へのアクセス
+      - | Google、jsdelivr、unpkg
+        | ※スタイルシート・javascriptライブラリ目的
+        | ※上記以外への外部へのアクセスは行っていません。
+        | ※ユーザーデータを外部へ送信する機能は一切持っていません。
+    * - 端末(PC)へのアクセス
+      - | ＜開く＞
+        | ・VRMなど3Dオブジェクトファイル、画像ファイル、音楽ファイル
+        | ・動画ファイル
+        | ・.vvmposeファイル、.vvmmotファイル、.vvmprojファイル
+        | 
+        | ＜保存する＞
+        | ・スクリーンショット
+        | ・動画ファイル
+        | ・.vvmposeファイル、.vvmmotファイル、.vvmprojファイル
+
+
+.. note::
+    * 利用にあたりUnity本体や追加のライブラリ等は不要です。
+    * PWA（Progressive Wab App）対応のため、インストールしてブラウザから独立して利用可能です。
+    * Windows, macOS、Linuxは単独で動作するスタンドアロン版も用意する予定です。
+    * マウスジェスチャーのあるブラウザ・拡張機能は誤操作の可能性があるので事前にオフにするか後述のキー操作をする必要があります。
+    * 通信量はあくまでも目安です。PWA対応のため通信はアプリの読み込み・アップデート時にしか原則として行わないようにしています。
+    * 初回以後、むやみにリロードはしないでください。アップデートは用意できましたらアプリ上で通知いたします。
diff --git a/docs/source/man1/feature.rst b/docs/source/man1/feature.rst
@@ -0,0 +1,47 @@
+###############
+特徴
+###############
+
+できること
+--------------
+
+　本アプリで主にできることは次のとおりです。
+
+* VRMファイルの読み込み（VRMの身長の情報表示にも対応）
+* VRMのボーン操作（着実に簡単操作を体感していただくため、IKによる操作のみ）
+* FBX・Obj・STLなど3Dモデルファイルの読み込み・変形（※1）
+* jpg・png・gifなど2D画像の読み込み・変形
+* カメラ・ライト・エフェクト・ポストプロセッシング（画面効果のこと）を使用可能（Unityの機能）
+* オーディオ対応（MP3、wav）（※2）
+* VRMと他のオブジェクトを連動して動かせる
+* VRMのみ、ポーズをポーズファイルに保存・読み込み可能
+* アニメーション作成可能（簡単なタイムライン・キーフレーム方式採用）
+* アニメーションをプロジェクトファイルとして保存・読み込み可能
+* WebGL部分の画面サイズを自由に変更可能
+* 現在の画面をスクリーンショットとして保存可能
+* 現在の画面を動画撮影・保存可能（もちろんアニメーションの保存も可能）
+* 多言語対応（日本語、英語、エスペラント語、他は今後追加予定）
+* GoogleのMediaPipeによりカメラ映像からポーズをAIで自動検出して再現可能（※3）
+
+.. note::
+    ※1 TriLib2で対応可能なフォーマットすべて（https://ricardoreis.net/trilib-2/）
+
+    ※2 UnityのWebGLで対応していないオーディオ効果もあります。
+
+    ※3 実験機能のため、完全な再現とはならない可能性もあります。
+
+|
+
+できないこと
+--------------
+
+　本アプリで現在のバージョン（1.0.0）でできないことは次のとおりです。
+
+* VRoidHubからVRoidを読み込むこと（VRoidSDKはC#だけのため、HTMLからはセキュリティ的に無理）
+* VRMを編集・加工して保存すること（本アプリの目的ではないため非対応）
+* その他ネット上のVRM、FBX、Objなどを読み込むこと（ウェブアプリのため制限があります）
+* ogg（Ogg Vorbis）音声ファイルの読み込み（UnityのWebGLがそもそもoggのストリーミングに未対応）
+
+.. note::
+    ※今後、利用しているアセットやライブラリ等がバージョンアップしたら本アプリでも利用可能になるかもしれません。ご了承ください。
+
diff --git a/docs/source/man1/initial.rst b/docs/source/man1/initial.rst
@@ -0,0 +1,33 @@
+##########
+はじめに
+##########
+
+　本アプリはMMDのようにVRoid(VRM)でアニメーションを手軽に作ることを目指したアプリです。
+本格的な3Dアニメーションを目指したわけではないので、本アプリで作ったアニメーションは（今のところ）
+本アプリでしか再生できませんが、Unityのエディタ上で直接作るより遥かに手軽にできるはずです。
+それからウェブアプリになっているため、ウェブブラウザでどこでも使えるのが特徴です。
+（技術的な面で制限がかかる機能もあります）
+
+
+VRoid(VRM)とは？
+=================
+
+
+　VRアプリケーションや3Dゲーム等で使われる、規格として統一された使いやすい新しい3Dモデル、それがVRoid(VRM）です。
+VRMは3Dモデル規格・アニメーションツール界隈として世間に大きく貢献した、かの有名なMMDよりも仕様が整った形で
+広く公開されており、汎用的に使いやすいのが特徴です。そして積極的に開発・運用が続けられていてサポート面でもバッチリです。
+
+　対応アプリ数もMMDモデルに匹敵しているようで、今やAndroid/iOS等のスマートフォンアプリ、PCやVR機器のアプリケーションなど
+多彩に活躍の場を展開しています。
+　もともとVRアプリのアバターを想定して作られたそうですが、VRM単体で3Dアニメーションさせることも可能です。
+Unityというゲーム作成環境ならば個人レベルでも、Unityのアニメーション機能でもってVRMの手足を動かして
+ポージング・アニメーションさせることができます。
+
+　ただ、Unity導入・VRM読み込みライブラリの導入そしてUnityのアニメーション機能の取り扱いはなかなかに困難です。
+アニメーションを制作しやすくするVeryAnimationなどのアセットを使わなければ（使ってもなお）敷居が高いでしょう。
+　そういう現状を踏まえるとVRMにはソフトウェアとしてのMMDに匹敵するソフトウェアがまだまだ少ないのが一番のデメリットと
+個人的には考えています。(あったとしてもUnityやその他アニメーションツールなど、
+大げさなツールでモーションを作らなければいけなかったりするのがまた面倒だったり・・・)
+
+　そこで本アプリでは、作者の私自身がUnityでVeryAnimationなどのアニメーション作成支援アセットを色々試して断念し、
+だったら自分が使いやすいVRM操作ライブラリ・アニメーション作成アプリを作って世間に貢献しようと思い立ったのがスタートでした。