Skip to content

Commit 7ce417c

Browse files
sindhartasindharta
authored
feat: prepare for creating a package: com.unity.meshsync-dcc-plugin (#27)
* Moved plugin-building related files to Plugins~ * Added initial package-related files * Added initial yamato settings * Renamed license to License.md * Added new Unity project (for testing) and symlinks that link the project to the package * Added missing meta files * Added DCC plugin binaries into the package * Added a test to verify if the package contains plugin binaries * Added the first documentation * Added npmignore gitignore: * temporary build files of the new Unity project and and of the plugin building steps. * Ignore idea and project cache files
1 parent 2c76e9f commit 7ce417c

File tree

349 files changed

+2739
-60
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

349 files changed

+2739
-60
lines changed

‎.gitignore‎

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -22,40 +22,52 @@
2222
*.swp
2323

2424
# CMake
25-
Build/Build/MeshSync**
26-
Build/CMakeCache.txt
27-
Build/CMakeFiles**
28-
Build/CMakeScripts/**
29-
Build/cmake_install.cmake
30-
Build/Makefile
31-
Build/MeshSync-**
32-
Build/Blender-**
33-
Build/blender-**
34-
Build/Python-**
35-
Build/mqsdk**
36-
Build/ispc**
37-
Build/*.xcodeproj/**
38-
Build/ispc**
39-
Build/*.vcxproj**
40-
Build/*.sln
41-
Build/Src**
42-
Build/install_manifest.txt
25+
Plugins~/Build/Build/MeshSync**
26+
Plugins~/Build/CMakeCache.txt
27+
Plugins~/Build/CMakeFiles**
28+
Plugins~/Build/CMakeScripts/**
29+
Plugins~/Build/cmake_install.cmake
30+
Plugins~/Build/Makefile
31+
Plugins~/Build/MeshSync-**
32+
Plugins~/Build/Blender-**
33+
Plugins~/Build/blender-**
34+
Plugins~/Build/Python-**
35+
Plugins~/Build/mqsdk**
36+
Plugins~/Build/ispc**
37+
Plugins~/Build/*.xcodeproj/**
38+
Plugins~/Build/ispc**
39+
Plugins~/Build/*.vcxproj**
40+
Plugins~/Build/*.sln
41+
Plugins~/Build/Src**
42+
Plugins~/Build/install_manifest.txt
4343

4444
# XCode
45-
Build/MeshSyncDCCPlugin.build/**
45+
Plugins~/Build/MeshSyncDCCPlugin.build/**
4646

4747
# Visual Studio
48-
Build/.vs
49-
Build/x64
50-
Src/.vs
51-
Src/*.vcxproj**
48+
Plugins~/Build/.vs
49+
Plugins~/Build/x64
50+
Plugins~/.vs
51+
Plugins~/*.vcxproj**
5252

5353
# Symbolic links
54-
Src/MeshSyncClientMAYA_*
55-
Src/MeshSyncClientBLENDER_*
56-
Src/MeshSyncClient3DSMAX_*
57-
Src/MeshSyncClientMOTIONBUILDER_*
58-
Src/MeshSyncClientMQ_*
54+
Plugins~/Src/MeshSyncClientMAYA_*
55+
Plugins~/Src/MeshSyncClientBLENDER_*
56+
Plugins~/Src/MeshSyncClient3DSMAX_*
57+
Plugins~/Src/MeshSyncClientMOTIONBUILDER_*
58+
Plugins~/Src/MeshSyncClientMQ_*
5959

6060
# Files to be distributed (Build results)
61-
Dist/UnityMeshSync_**
61+
Plugins~/Dist/UnityMeshSync_**
62+
63+
# Sample Project
64+
MeshSyncDCCPlugin~/Library/**
65+
MeshSyncDCCPlugin~/*.sln
66+
MeshSyncDCCPlugin~/*.csproj
67+
MeshSyncDCCPlugin~/Logs/**
68+
MeshSyncDCCPlugin~/Temp/**
69+
MeshSyncDCCPlugin~/obj/**
70+
71+
# Rider
72+
**/.idea/**
73+

‎.npmignore‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
artifacts/**
2+
build/**
3+
.build_script/**
4+
node_modules/**
5+
Documentation/ApiDocs/**
6+
Documentation~/ApiDocs/**
7+
AE~/**
8+
.DS_Store
9+
.npmrc
10+
.npmignore
11+
.gitignore
12+
CONTRIBUTING.md
13+
CONTRIBUTING.md.meta
14+
QAReport.md
15+
QAReport.md.meta
16+
.gitlab-ci.yml
17+
build.sh
18+
build.sh.meta
19+
build.bat
20+
build.bat.meta
21+
22+
# Plugins and test project code
23+
Plugins~/**
24+
MeshSyncDCCPlugin~/**
25+
26+
# Don't ignore DCC plugin zip files
27+
!Editor/Plugins~/*.zip
28+
29+
30+

‎.yamato/promotion-MeshSyncDCCPlugin.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
yamato_name: MeshSyncDCCPlugin
2+
test_editors:
3+
- version: 2019.3
4+
test_platforms:
5+
- name: win
6+
type: Unity::VM
7+
image: package-ci/win10:stable
8+
flavor: b1.large
9+
---
10+
{% for editor in test_editors %}
11+
{% for platform in test_platforms %}
12+
promotion_test_{{ platform.name }}_{{ editor.version }}:
13+
name : {{ yamato_name }} Promotion Test {{ editor.version }} on {{ platform.name }}
14+
agent:
15+
type: {{ platform.type }}
16+
image: {{ platform.image }}
17+
flavor: {{ platform.flavor}}
18+
variables:
19+
UPMCI_PROMOTION: 1
20+
commands:
21+
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
22+
- upm-ci package test --unity-version {{ editor.version }}
23+
artifacts:
24+
{{ yamato_name }}_promotion_test_results:
25+
paths:
26+
- "upm-ci~/test-results/**/*"
27+
dependencies:
28+
- .yamato/upm-ci-{{ yamato_name }}.yml#pack
29+
{% endfor %}
30+
{% endfor %}
31+
32+
promote:
33+
name: Promote {{ yamato_name }} to Production
34+
agent:
35+
type: Unity::VM
36+
image: package-ci/win10:stable
37+
flavor: b1.large
38+
variables:
39+
UPMCI_PROMOTION: 1
40+
commands:
41+
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
42+
- upm-ci package promote
43+
triggers:
44+
tags:
45+
only:
46+
- /^(r|R)elease-\d+\.\d+\.\d+(-preview(\.\d+)?)?$/
47+
artifacts:
48+
{{ yamato_name }}_promote_artifacts:
49+
paths:
50+
- "upm-ci~/packages/*.tgz"
51+
dependencies:
52+
- .yamato/upm-ci-{{ yamato_name }}.yml#pack
53+
{% for editor in test_editors %}
54+
{% for platform in test_platforms %}
55+
- .yamato/promotion-{{ yamato_name }}.yml#promotion_test_{{ platform.name }}_{{ editor.version }}
56+
{% endfor %}
57+
{% endfor %}

‎.yamato/upm-ci-MeshSyncDCCPlugin.yml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
yamato_name: MeshSyncDCCPlugin
2+
test_editors:
3+
- version: 2019.3
4+
platforms:
5+
- name: win
6+
type: Unity::VM
7+
image: package-ci/win10:stable
8+
flavor: b1.large
9+
plugin_path: Runtime/Plugins/x86_64/**
10+
11+
---
12+
13+
pack:
14+
name: Pack {{ yamato_name }}
15+
agent:
16+
type: Unity::VM
17+
image: package-ci/win10:stable
18+
flavor: b1.large
19+
commands:
20+
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
21+
- upm-ci package pack
22+
artifacts:
23+
{{ yamato_name }}_pack_artifacts:
24+
paths:
25+
- "upm-ci~/**/*"
26+
27+
{% for editor in test_editors %}
28+
{% for platform in platforms %}
29+
test_{{ platform.name }}_{{ editor.version }}:
30+
name : Test {{ yamato_name }} using {{ editor.version }} on {{ platform.name }}
31+
agent:
32+
type: {{ platform.type }}
33+
image: {{ platform.image }}
34+
flavor: {{ platform.flavor}}
35+
commands:
36+
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
37+
- upm-ci package test --unity-version {{ editor.version }}
38+
triggers:
39+
branches:
40+
only:
41+
- "/.*/"
42+
except:
43+
- "dev"
44+
45+
artifacts:
46+
{{ yamato_name }}_test_results:
47+
paths:
48+
- "upm-ci~/test-results/**/*"
49+
dependencies:
50+
- .yamato/upm-ci-{{ yamato_name }}.yml#pack
51+
{% endfor %}
52+
{% endfor %}
53+
54+
publish:
55+
name: Publish {{ yamato_name }} to Internal Registry
56+
agent:
57+
type: Unity::VM
58+
image: package-ci/win10:stable
59+
flavor: b1.large
60+
commands:
61+
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
62+
- upm-ci package publish
63+
triggers:
64+
tags:
65+
only:
66+
- /^(r|R)(c|C)-\d+\.\d+\.\d+(-preview(\.\d+)?)?$/
67+
artifacts:
68+
{{ yamato_name }}_publish_artifacts:
69+
paths:
70+
- "upm-ci~/packages/*.tgz"
71+
dependencies:
72+
- .yamato/upm-ci-{{ yamato_name }}.yml#pack
73+
{% for editor in test_editors %}
74+
{% for platform in platforms %}
75+
- .yamato/upm-ci-{{ yamato_name }}.yml#test_{{ platform.name }}_{{ editor.version }}
76+
{% endfor %}
77+
{% endfor %}
78+
79+
80+
publish_dry_run:
81+
name: Publish Dry Run {{ yamato_name }}
82+
agent:
83+
type: Unity::VM
84+
image: package-ci/win10:stable
85+
flavor: b1.large
86+
commands:
87+
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
88+
- upm-ci package publish --dry-run
89+
triggers:
90+
tags:
91+
only:
92+
- /^(r|R)(c|C)-\d+\.\d+\.\d+(-preview(\.\d+)?)?$/
93+
artifacts:
94+
{{ yamato_name }}_publish_artifacts:
95+
paths:
96+
- "upm-ci~/packages/*.tgz"
97+
dependencies:
98+
- .yamato/upm-ci-{{ yamato_name }}.yml#pack
99+
{% for editor in test_editors %}
100+
{% for platform in platforms %}
101+
- .yamato/upm-ci-{{ yamato_name }}.yml#test_{{ platform.name }}_{{ editor.version }}
102+
{% endfor %}
103+
{% endfor %}
104+
105+

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Changelog
2+
3+
## [0.0.1-preview] - 2020-04-10
4+
5+
The first release of *MeshSyncDCCPlugin*, which contains plugin binaries of DCC tools for using *MeshSync* 0.0.3-preview
6+

‎CHANGELOG.md.meta‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
## If you are interested in contributing, here are some ground rules:
4+
* ... Define guidelines & rules for what contributors need to know to successfully make Pull requests against your repo ...
5+
6+
## All contributions are subject to the [Unity Contribution Agreement(UCA)](https://unity3d.com/legal/licenses/Unity_Contribution_Agreement)
7+
By making a pull request, you are confirming agreement to the terms and conditions of the UCA, including that your Contributions are your original creation and that you have complete right and authority to make your Contributions.
8+
9+
## Once you have a change ready following these ground rules. Simply make a pull request

‎CONTRIBUTING.md.meta‎

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Documentation~/index.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# MeshSync DCC Plugin
2+
3+
MeshSync DCC Plugin is package that contains plugin binaries of DCC tools for using [MeshSync](https://docs.unity3d.com/Packages/com.unity.meshsync@latest),
4+
which is another package for synchronizing meshes/models editing in DCC tools into Unity in real time.
5+
This allows devs to immediately see how things will look in-game while modelling.
6+
7+
## Supported DCC Tools
8+
9+
| | Windows | Mac | Linux |
10+
| --------------------| ------------------ | ------------------ |------------------- |
11+
| Maya 2017 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
12+
| Maya 2018 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
13+
| Maya 2019 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
14+
| Maya 2020 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
15+
| Maya LT 2019 + | :white_check_mark: | | :x: |
16+
| 3ds Max 2017 | :white_check_mark: | :x: | :x: |
17+
| 3ds Max 2018 | :white_check_mark: | :x: | :x: |
18+
| 3ds Max 2019 | :white_check_mark: | :x: | :x: |
19+
| 3ds Max 2020 | :white_check_mark: | :x: | :x: |
20+
| MotionBuilder 2017 | :white_check_mark: | :x: | :white_check_mark: |
21+
| MotionBuilder 2018 | :white_check_mark: | :x: | :white_check_mark: |
22+
| MotionBuilder 2019 | :white_check_mark: | :x: | :white_check_mark: |
23+
| MotionBuilder 2020 | :white_check_mark: | :x: | :white_check_mark: |
24+
| Blender 2.79b | :white_check_mark: | :white_check_mark: | :white_check_mark: |
25+
| Blender 2.80 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
26+
| Modo 12 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
27+
| Modo 13 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
28+
| Metasequoia 4.x | :white_check_mark: | :white_check_mark: | |
29+
30+
Notes:
31+
* :white_check_mark: : Supported
32+
* :x: : Impossible to support (platform unsupported by the DCC, etc)
33+
* empty : May be supported in the future

‎Documentation~/jp/index.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# MeshSync DCC Plugin
2+
3+
MeshSyncDCCPlugin は DCC ツール上のモデルの編集をリアルタイムに Unity に反映させるためのパッケージ:
4+
[MeshSync](https://docs.unity3d.com/Packages/com.unity.meshsync@latest) と連携するための DCC プラグインの格納するパッケージです。
5+
MeshSync と MeshSyncDCCPlugin が連携することで、ゲーム上でどう見えるかをその場で確認しながらモデリングすることができます。
6+
7+
サポートされている DCC ツールにインストールする手順については [インストール](Docs/jp/Installation.md) を参照して下さい。
8+
9+
## サポートされている DCC ツール
10+
11+
| | Windows | Mac | Linux |
12+
| --------------------| ------------------ | ------------------ |------------------- |
13+
| Maya 2017 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
14+
| Maya 2018 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
15+
| Maya 2019 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
16+
| Maya 2020 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
17+
| Maya LT 2019 + | :white_check_mark: | | :x: |
18+
| 3ds Max 2017 | :white_check_mark: | :x: | :x: |
19+
| 3ds Max 2018 | :white_check_mark: | :x: | :x: |
20+
| 3ds Max 2019 | :white_check_mark: | :x: | :x: |
21+
| 3ds Max 2020 | :white_check_mark: | :x: | :x: |
22+
| MotionBuilder 2017 | :white_check_mark: | :x: | :white_check_mark: |
23+
| MotionBuilder 2018 | :white_check_mark: | :x: | :white_check_mark: |
24+
| MotionBuilder 2019 | :white_check_mark: | :x: | :white_check_mark: |
25+
| MotionBuilder 2020 | :white_check_mark: | :x: | :white_check_mark: |
26+
| Blender 2.79b | :white_check_mark: | :white_check_mark: | :white_check_mark: |
27+
| Blender 2.80 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
28+
| Modo 12 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
29+
| Modo 13 | :white_check_mark: | :white_check_mark: | :white_check_mark: |
30+
| Metasequoia 4.x | :white_check_mark: | :white_check_mark: | |
31+
32+
メモ:
33+
* :white_check_mark: : 対応済み
34+
* :x: : 対応することが不可能 (その OS で、DCC ツールが動作しないなど)
35+
* empty : これから対応する可能性がある

0 commit comments

Comments
 (0)