Skip to content

Commit

Permalink
Add Package Starter Kit content and update project structure and asse…
Browse files Browse the repository at this point in the history
…mbly names to follow the template
  • Loading branch information
mtschoen-unity committed Jun 7, 2019
1 parent 43ce8ee commit d91c585
Show file tree
Hide file tree
Showing 2,071 changed files with 430 additions and 121 deletions.
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
artifacts/**
build/**
.build_script/**
node_modules/**
.DS_Store
.npmrc
!Documentation~
!.Documentation
npm-debug.log
build.sh.meta
build.bat.meta
.idea/
12 changes: 6 additions & 6 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[submodule "libs/input-prototype"]
path = libs/input-prototype
[submodule "Runtime/libs/input-prototype"]
path = Runtime/libs/input-prototype
url=https://github.com/Unity-Technologies/input-prototype.git
branch = editorvr/main
[submodule "libs/UnityOctree"]
path = libs/UnityOctree
[submodule "Runtime/libs/UnityOctree"]
path = Runtime/libs/UnityOctree
url=https://github.com/Unity-Technologies/UnityOctree.git
[submodule "libs/VRLineRenderer"]
path = libs/VRLineRenderer
[submodule "Runtime/libs/VRLineRenderer"]
path = Runtime/libs/VRLineRenderer
url = https://github.com/Unity-Technologies/VRLineRenderer
19 changes: 19 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
artifacts/**
build/**
.build_script/**
node_modules/**
Documentation/ApiDocs/**
Documentation~/ApiDocs/**
.DS_Store
.npmrc
.npmignore
.gitignore
CONTRIBUTING.md
CONTRIBUTING.md.meta
QAReport.md
QAReport.md.meta
.gitlab-ci.yml
build.sh
build.sh.meta
build.bat
build.bat.meta
92 changes: 92 additions & 0 deletions .yamato/promotion.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
test_editors:
- version: 2019.1
test_platforms:
- name: win
type: Unity::VM
image: package-ci/win10:stable
flavor: m1.large
---
promotion_fetch:
name: Fetch Package From Internal Registry
agent:
type: Unity::VM
image: package-ci/win10:stable
flavor: m1.large
variables:
UPMCI_PROMOTION: 1
commands:
- npm install upm-ci-utils@latest -g --registry https://api.bintray.com/npm/unity/unity-npm
- upm-ci package pack
artifacts:
packages:
paths:
- "upm-ci~/packages/**/*"

{% for editor in test_editors %}
{% for platform in test_platforms %}
promotion_test_{{ platform.name }}_{{ editor.version }}:
name : Promotion Test {{ editor.version }} on {{ platform.name }}
agent:
type: {{ platform.type }}
image: {{ platform.image }}
flavor: {{ platform.flavor}}
variables:
UPMCI_PROMOTION: 1
commands:
- npm install upm-ci-utils@latest -g --registry https://api.bintray.com/npm/unity/unity-npm
- upm-ci package test --unity-version {{ editor.version }}
artifacts:
logs:
paths:
- "upm-ci~/test-results/**/*"
dependencies:
- .yamato/promotion.yml#promotion_fetch
{% endfor %}
{% endfor %}

promotion_test_trigger:
name: Promotion Tests Trigger
agent:
type: Unity::VM
image: package-ci/win10:stable
flavor: m1.large
artifacts:
logs:
paths:
- "upm-ci~/test-results/**/*"
packages:
paths:
- "upm-ci~/packages/**/*"
dependencies:
{% for editor in test_editors %}
{% for platform in test_platforms %}
- .yamato/promotion.yml#promotion_test_{{platform.name}}_{{editor.version}}
{% endfor %}
{% endfor %}

promote:
name: Promote to Production
agent:
type: Unity::VM
image: package-ci/win10:stable
flavor: m1.large
variables:
UPMCI_PROMOTION: 1
commands:
- npm install upm-ci-utils@latest -g --registry https://api.bintray.com/npm/unity/unity-npm
- upm-ci package promote
triggers:
tags:
only:
- /^(r|R)elease-\d+\.\d+\.\d+(-preview(\.\d+)?)?$/
artifacts:
artifacts:
paths:
- "upm-ci~/packages/*.tgz"
dependencies:
- .yamato/promotion.yml#promotion_fetch
{% for editor in test_editors %}
{% for platform in test_platforms %}
- .yamato/promotion.yml#promotion_test_{{ platform.name }}_{{ editor.version }}
{% endfor %}
{% endfor %}
98 changes: 98 additions & 0 deletions .yamato/upm-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
test_editors:
- version: 2019.1
- version: trunk
test_platforms:
- name: win
type: Unity::VM
image: package-ci/win10:stable
flavor: m1.large
- name: mac
type: Unity::VM::osx
image: buildfarm/mac:stable
flavor: m1.mac
---
pack:
name: Pack
agent:
type: Unity::VM
image: package-ci/win10:stable
flavor: m1.large
commands:
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
- upm-ci package pack
artifacts:
packages:
paths:
- "upm-ci~/**/*"

{% for editor in test_editors %}
{% for platform in test_platforms %}
test_{{ platform.name }}_{{ editor.version }}:
name : Test {{ editor.version }} on {{ platform.name }}
agent:
type: {{ platform.type }}
image: {{ platform.image }}
flavor: {{ platform.flavor}}
commands:
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
- upm-ci package test --unity-version {{ editor.version }}
artifacts:
logs:
paths:
- "upm-ci~/test-results/**/*"
dependencies:
- .yamato/upm-ci.yml#pack
{% endfor %}
{% endfor %}

test_trigger:
name: Tests Trigger
agent:
type: Unity::VM
image: package-ci/win10:stable
flavor: m1.large
commands:
- dir
triggers:
branches:
only:
- "/.*/"
artifacts:
logs:
paths:
- "upm-ci~/test-results/**/*"
packages:
paths:
- "upm-ci~/packages/**/*"
dependencies:
- .yamato/upm-ci.yml#pack
{% for editor in test_editors %}
{% for platform in test_platforms %}
- .yamato/upm-ci.yml#test_{{platform.name}}_{{editor.version}}
{% endfor %}
{% endfor %}

publish:
name: Publish to Internal Registry
agent:
type: Unity::VM
image: package-ci/win10:stable
flavor: m1.large
commands:
- npm install upm-ci-utils@stable -g --registry https://api.bintray.com/npm/unity/unity-npm
- upm-ci package publish
triggers:
tags:
only:
- /^(r|R)(c|C)-\d+\.\d+\.\d+(-preview(\.\d+)?)?$/
artifacts:
artifacts:
paths:
- "upm-ci~/packages/*.tgz"
dependencies:
- .yamato/upm-ci.yml#pack
{% for editor in test_editors %}
{% for platform in test_platforms %}
- .yamato/upm-ci.yml#test_{{ platform.name }}_{{ editor.version }}
{% endfor %}
{% endfor %}
9 changes: 0 additions & 9 deletions AssemblyInfo.cs

This file was deleted.

11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Changelog
All notable changes to this package will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2017-MM-DD

### This is the first release of *Unity Package \<Your package name\>*.

*Short description of this release*
7 changes: 7 additions & 0 deletions CHANGELOG.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Contributing

## If you are interested in contributing, here are some ground rules:
* ... Define guidelines & rules for what contributors need to know to successfully make Pull requests against your repo ...

## All contributions are subject to the [Unity Contribution Agreement(UCA)](https://unity3d.com/legal/licenses/Unity_Contribution_Agreement)
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.

## Once you have a change ready following these ground rules. Simply make a pull request
7 changes: 7 additions & 0 deletions CONTRIBUTING.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 56 additions & 0 deletions Documentation~/editorxr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# EditorXR
Author XR in XR - Initial public release was on December 15, 2016 via [blogpost](https://blogs.unity3d.com/2016/12/15/editorvr-experimental-build-available-today/)

## Experimental Status
It’s important to note that EditorXR is an experimental feature. As such, there is no formal support (e.g. FogBugz, [email protected], Premium Support, etc.) offered, so please do not use these channels. Instead, take your questions, suggestions, comments to our dedicated [forum](https://forum.unity3d.com/forums/editorvr.126/).

To help ensure you have a good experience, and to help us answer your questions (hey, we’re a small team!), we encourage you to try it out first with a small VR-ready scene. Please use life-sized objects, nothing too big or small. Dive in and have fun just playing around, instead of trying to use your existing project.

**As with any experimental/preview/alpha/beta build, it is always a good idea to make a backup of your project before using the build.**

Experimental means this:
- We're still adding features!
- The current menus, tools, workspaces, actions, etc. are not the end-all-be-all. Each of these have individual designs that will change as we experiment with what works best for UX. EditorXR was designed in such a way that we plan on you being able to replace all of these defaults, too, if you so desire.
- Namespaces, classes, software architecture, prefabs, etc. can change at any point. If you are writing your own tools, then you might need to update them as these things change.
- There won’t always be an upgrade path from one release to the next, so you might need to fix things manually, which leads to the next point...
- Stuff can and will break (!)
- There’s **no guarantee** that this project will move out of experimental status within any specific timeframe.
- As such, there is no guarantee that this will remain an actively supported project.

## Getting Started
If you've made it here, but aren't accustomed to using GitHub, cloning repositories, etc. and are simply looking to give EditorXR a spin, then take a look at the [Getting Started Guide](https://docs.google.com/document/d/1RD0SAjWnXdtY6eOC4qHk_fcl7w2-aBGrF3rX5pk5KDo). Once you're up and running we recommend you join the discussion on the [EditorXR forum](https://forum.unity3d.com/forums/editorvr.126/).

## For Software Developers
If you're a developer, we recommend that you take a look at the [Getting Started Guide](https://docs.google.com/document/d/1RD0SAjWnXdtY6eOC4qHk_fcl7w2-aBGrF3rX5pk5KDo) *and* the companion document [Extending EditorXR](https://docs.google.com/document/d/1EGi9hKXAujfBMI2spErojdqRc0giqEnOu0NpwgBxtpg). You'll need to clone the repository into an existing project using the instructions below.

### Git Dependencies
- [git-lfs](https://git-lfs.github.com/)
- [git-submodule](https://git-scm.com/docs/git-submodule)

### Project Asset Dependencies
- [Textmesh Pro](https://docs.unity3d.com/Packages/[email protected]/manual/index.html#installation)
- [Legacy Input Helpers](https://docs.unity3d.com/Packages/[email protected]/manual/index.html#installing-comunityxrlegacyinputhelpers) (2019.1+)
- Users of 2018.3 do not need Legacy Input Helpers

### Cloning
1. Create a new Unity project or use an existing one
2. From the command line change directory to your project's `Assets` directory.
3. Run `git lfs clone --recursive -b development https://github.com/Unity-Technologies/EditorXR` **(Use HTTPS!)**

### Updating
Because this project uses [git-submodule](https://git-scm.com/docs/git-submodule), you'll need to execute `git submodule update` after pulling whenever a submodule is updated. You could execute this command always just to be safe or if you notice that a submodule is showing as modified after pulling changes.

Optionally, you could add a [git hook for post-checkout](https://ttboj.wordpress.com/2014/05/06/keeping-git-submodules-in-sync-with-your-branches/) or use a GUI (e.g. SourceTree) that does this automatically for you.

### Project Settings
If you plan on making changes to EditorXR and/or contributing back, then you'll need to set the `Asset Serialization` property under Edit->Project Settings->Editor to `Force Text`.

### Assembly Definitions
In order to support a variety of platform configurations, and to optionally strip its code out of player builds, EditorXR uses assembly definitions. Some of EditorXR's dependencies do not include assembly definitions in their current forms, so after importing EditorXR (in Unity 2018.3 and below), you must add them.

For easy set-up, EditorXR includes a .unitypackage (`Patches/Dependencies_asmdef.unitypackage`) containing an assembly definition for the PolyToolkit and UnityEngine.SpatialTracking, which are referenced by EditorXR. Simply import it via Assets > Import Package > Custom Package...

This is not required for Unity versions 2019.1 and above, though you will need to add an assembly definition in order to reference PolyToolkit.

## All contributions are subject to the [Unity Contribution Agreement (UCA)](https://unity3d.com/legal/licenses/Unity_Contribution_Agreement)
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.
2 changes: 1 addition & 1 deletion Editor/BuildCallbacks.cs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class AssemblyDefinition
public string[] ExcludePlatforms { get { return excludePlatforms; } set { excludePlatforms = value; } }
}

static readonly string[] k_AssemblyNames = { "EXR", "EXR-Dependencies", "input-prototype", "VRLR" };
static readonly string[] k_AssemblyNames = { "Unity.Labs.EditorXR", "input-prototype", "VRLR" };
static readonly string[] k_IncludePlatformsOverride = { "Editor" };
static readonly string[] k_ExcludePlatformsOverride = { };
static readonly Dictionary<string, string[]> k_IncludePlatforms = new Dictionary<string, string[]>();
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "EXR-Editor",
"name": "Unity.Labs.EditorXR.Editor",
"references": [
"EXR",
"Unity.Labs.EditorXR",
"Unity.TextMeshPro",
"Unity.Labs.Utils"
],
Expand All @@ -15,4 +15,4 @@
"precompiledReferences": [],
"autoReferenced": true,
"defineConstraints": []
}
}
File renamed without changes.
2 changes: 1 addition & 1 deletion LICENSE → LICENCE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
EditorVR copyright © 2016 Unity Technologies ApS
EditorXR copyright © 2018 Unity Technologies ApS

Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](http://www.unity3d.com/legal/licenses/Unity_Companion_License).
Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](http://www.unity3d.com/legal/licenses/Unity_Companion_License).

Unless expressly provided otherwise, the Software under this license is made available strictly on an “AS IS” BASIS WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. Please review the license for details on these and other terms and conditions.
File renamed without changes.
Loading

0 comments on commit d91c585

Please sign in to comment.