From 21f4e7be1afae3cfa2735c9971d50183798fc71b Mon Sep 17 00:00:00 2001 From: Kalila L Date: Tue, 1 Dec 2020 05:50:47 -0500 Subject: [PATCH 1/2] Initial reference added. --- docs/source/create/applications.rst | 2 +- docs/source/script.rst | 8 +++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/source/create/applications.rst b/docs/source/create/applications.rst index 3ab6b103..ca3b9311 100644 --- a/docs/source/create/applications.rst +++ b/docs/source/create/applications.rst @@ -282,7 +282,7 @@ The gemstone will be created when gemstoneApp.js receives click events from each } } -Congratulations, you have successfully created an app in Athena! To use your app, upload it to a cloud platform, such as Amazon S3, Google Cloud Storage, Microsoft Azure, etc. Once hosted, you can install it and use it: +Congratulations, you have successfully created an app in Vircadia! To use your app, upload it to a cloud platform, such as Amazon S3, Google Cloud Storage, Microsoft Azure, etc. Once hosted, you can install it and use it: 1. In Interface, go to **Edit > Running Scripts**. 2. Under Load Scripts, click 'From URL' and enter the URL to your hosted JavaScript file. diff --git a/docs/source/script.rst b/docs/source/script.rst index 6fd4fb39..975ef83d 100644 --- a/docs/source/script.rst +++ b/docs/source/script.rst @@ -2,7 +2,13 @@ Script ############################# -Vircadia uses scripts (written in JavaScript) for a number of different things: creating content, moving your avatar, playing audio at a specific location, wearing an avatar attachment, and much more. +Vircadia uses scripts (written in JavaScript) for a number of different things: creating content, moving your avatar, playing audio at a specific location, wearing an avatar attachment, and much more. + +There are a number of API's available to you as a scripter. The overall scripting engine's API's can be found `here `_. + +There are also helper modules and entire frameworks built on top of the scripting engine that you can take advantage of `here <#>`_. + +.. note:: Technical: Vircadia uses the `QtScript `_ JavaScript engine. Throughout this chapter, learn about the different types of scripts and how you can use them to create new experiences: From 303a8c760716418367cf8bad957736cbd41f8328 Mon Sep 17 00:00:00 2001 From: Kalila L Date: Tue, 1 Dec 2020 05:52:15 -0500 Subject: [PATCH 2/2] Update references 'kasen/core' -> 'master' --- docs/source/create/avatars/custom-animations.rst | 4 ++-- docs/source/create/avatars/find-avatars.rst | 4 ++-- docs/source/developer/build/BUILD_LINUX.md | 2 +- docs/source/host/server-setup/windows-server.rst | 2 +- docs/source/locales/de/LC_MESSAGES/create.po | 8 ++++---- docs/source/locales/de/LC_MESSAGES/explore.po | 2 +- docs/source/locales/de/LC_MESSAGES/host.po | 2 +- docs/source/locales/de/LC_MESSAGES/release-notes.po | 4 ++-- docs/source/locales/jp/LC_MESSAGES/create.po | 8 ++++---- docs/source/locales/jp/LC_MESSAGES/explore.po | 2 +- docs/source/locales/jp/LC_MESSAGES/host.po | 2 +- docs/source/locales/jp/LC_MESSAGES/release-notes.po | 4 ++-- docs/source/release-notes/v80.md | 2 +- docs/source/release-notes/v84.md | 2 +- 14 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/source/create/avatars/custom-animations.rst b/docs/source/create/avatars/custom-animations.rst index 91bfa0d1..1d3d4795 100644 --- a/docs/source/create/avatars/custom-animations.rst +++ b/docs/source/create/avatars/custom-animations.rst @@ -96,7 +96,7 @@ You can also override an existing animation role mapping: 1. Use `MyAvatar.getAnimationRoles `_ to view the list of roles for the current avatar. 2. You can replace the animation for each role with a custom animation (FBX file) using `MyAvatar.overrideRoleAnimation `_. -We've listed the animation roles and their description. These are frequently updated, so we recommend using ``MyAvatar.getAnimationRoles`` to get the latest animation roles before continuing. The standard animation FBX files for these roles can be found in the Vircadia source code repository on `GitHub `_. +We've listed the animation roles and their description. These are frequently updated, so we recommend using ``MyAvatar.getAnimationRoles`` to get the latest animation roles before continuing. The standard animation FBX files for these roles can be found in the Vircadia source code repository on `GitHub `_. +-------------------------------------------+----------------------------------------------------------------------+ | Animation Roles | Description | @@ -227,7 +227,7 @@ OR Examples ^^^^^^^^ -+ Here is the current default `avatar-animation.json `_ file. ++ Here is the current default `avatar-animation.json `_ file. + This `scoot-animation.json `_ file replaces the idle and walk animations with a sitting pose. This example shows how you can replace some of an avatar's default animations. diff --git a/docs/source/create/avatars/find-avatars.rst b/docs/source/create/avatars/find-avatars.rst index 67060024..be43a449 100644 --- a/docs/source/create/avatars/find-avatars.rst +++ b/docs/source/create/avatars/find-avatars.rst @@ -36,7 +36,7 @@ You will need the following to use this tool: + Unity (Recommended versions: 2017.4.17f1 - 2018.2.12f1) + Vircadia (v0.77.0 or higher) -+ `Vircadia Avatar Exporter for Unity `_ (v0.4.1) ++ `Vircadia Avatar Exporter for Unity `_ (v0.4.1) Please note that the recommended version of Unity is not the latest version. If you are using a newer version of Unity, we recommend that you apply a T-Pose to your avatar. To do so, go to the 'Inspector', and click 'Pose' near the bottom of the panel. Select 'Enforce T-Pose' from the drop-down. Click 'Apply' and 'Done'. We recommend doing this after correcting any issues with remapping bones. @@ -46,7 +46,7 @@ Install the Avatar Exporter You need to install the extension for every Unity project that you have. Keep in mind, however, that you can import and export multiple avatars in a single Unity project. -1. Download the `avatar exporter `_ from Vircadia. +1. Download the `avatar exporter `_ from Vircadia. 2. In Unity, open the 'Project' window at the bottom. .. image:: _images/project-window.png diff --git a/docs/source/developer/build/BUILD_LINUX.md b/docs/source/developer/build/BUILD_LINUX.md index f6287846..d426e9b4 100644 --- a/docs/source/developer/build/BUILD_LINUX.md +++ b/docs/source/developer/build/BUILD_LINUX.md @@ -86,7 +86,7 @@ git fetch -a Then checkout the main branch with: ```bash -git checkout kasen/core +git checkout master ``` ### Using a custom Qt build diff --git a/docs/source/host/server-setup/windows-server.rst b/docs/source/host/server-setup/windows-server.rst index 9ca48102..0fa00859 100644 --- a/docs/source/host/server-setup/windows-server.rst +++ b/docs/source/host/server-setup/windows-server.rst @@ -22,7 +22,7 @@ At a minimum, the computer that you use for your server should meet our `minimum To host a domain, you must be running Vircadia's open source `Client + Sandbox `_ software. -.. note:: While we do not publish an installer for Linux computers, you can still run a local domain server on a Linux machine. To do so, you will need to build the application from our code base. For more information, see our `Linux Build Guide `_. +.. note:: While we do not publish an installer for Linux computers, you can still run a local domain server on a Linux machine. To do so, you will need to build the application from our code base. For more information, see our `Linux Build Guide `_. --------------- diff --git a/docs/source/locales/de/LC_MESSAGES/create.po b/docs/source/locales/de/LC_MESSAGES/create.po index 6334d598..15b9a344 100644 --- a/docs/source/locales/de/LC_MESSAGES/create.po +++ b/docs/source/locales/de/LC_MESSAGES/create.po @@ -2674,7 +2674,7 @@ msgid "" "to get the latest animation roles before continuing. The standard " "animation FBX files for these roles can be found in the Vircadia source " "code repository on `GitHub `_." +"athena/tree/master/interface/resources/avatar/animations>`_." msgstr "" #: ../../source/create/avatars/custom-animations.rst:102 @@ -3071,7 +3071,7 @@ msgstr "" msgid "" "Here is the current default `avatar-animation.json " "`_ file." msgstr "" @@ -3287,7 +3287,7 @@ msgstr "" #: ../../source/create/avatars/find-avatars.rst:39 msgid "" "`Vircadia Avatar Exporter for Unity `_ (v0.4.1)" msgstr "" @@ -3315,7 +3315,7 @@ msgstr "" #: ../../source/create/avatars/find-avatars.rst:49 msgid "" "Download the `avatar exporter `_ from Vircadia." msgstr "" diff --git a/docs/source/locales/de/LC_MESSAGES/explore.po b/docs/source/locales/de/LC_MESSAGES/explore.po index b403bbaa..496e4128 100644 --- a/docs/source/locales/de/LC_MESSAGES/explore.po +++ b/docs/source/locales/de/LC_MESSAGES/explore.po @@ -3829,7 +3829,7 @@ msgstr "" #~ "code base. For more information, see " #~ "our `Linux Build Guide " #~ "`_." +#~ "athena/blob/master/BUILD_LINUX.md>`_." #~ msgstr "" #~ msgid "" diff --git a/docs/source/locales/de/LC_MESSAGES/host.po b/docs/source/locales/de/LC_MESSAGES/host.po index 138607b8..a1444199 100644 --- a/docs/source/locales/de/LC_MESSAGES/host.po +++ b/docs/source/locales/de/LC_MESSAGES/host.po @@ -3561,7 +3561,7 @@ msgid "" "run a local domain server on a Linux machine. To do so, you will need to " "build the application from our code base. For more information, see our " "`Linux Build Guide `_." +"athena/blob/master/BUILD_LINUX.md>`_." msgstr "" #: ../../source/host/server-setup/windows-server.rst:30 diff --git a/docs/source/locales/de/LC_MESSAGES/release-notes.po b/docs/source/locales/de/LC_MESSAGES/release-notes.po index e0e91a04..12e8f16a 100644 --- a/docs/source/locales/de/LC_MESSAGES/release-notes.po +++ b/docs/source/locales/de/LC_MESSAGES/release-notes.po @@ -2429,7 +2429,7 @@ msgid "" "The Vircadia Avatar Exporter for Unity has been updated to notify you of " "texture and file errors you may encounter while using the tool. Download " "the updated exporter here: https://github.com/kasenvr/project-" -"athena/tree/kasen/core/tools/unity-avatar-exporter" +"athena/tree/master/tools/unity-avatar-exporter" msgstr "" #: ../../source/release-notes/v80.md:37 ../../source/release-notes/v80.md:60 @@ -4152,7 +4152,7 @@ msgid "" "Introduced new build-time environment variable HIFI_VCPKG_BOOTSTRAP that " "will allow developers using Visual Studio 2019 to build the High Fidelity" " binaries. See the updated build guide for Windows here: " -"https://github.com/kasenvr/project-athena/blob/kasen/core/BUILD_WIN.md" +"https://github.com/kasenvr/project-athena/blob/master/BUILD_WIN.md" msgstr "" #: ../../source/release-notes/v84.md:46 diff --git a/docs/source/locales/jp/LC_MESSAGES/create.po b/docs/source/locales/jp/LC_MESSAGES/create.po index 65af5f8d..e393eb66 100644 --- a/docs/source/locales/jp/LC_MESSAGES/create.po +++ b/docs/source/locales/jp/LC_MESSAGES/create.po @@ -2672,7 +2672,7 @@ msgid "" "to get the latest animation roles before continuing. The standard " "animation FBX files for these roles can be found in the Vircadia source " "code repository on `GitHub `_." +"athena/tree/master/interface/resources/avatar/animations>`_." msgstr "" #: ../../source/create/avatars/custom-animations.rst:102 @@ -3069,7 +3069,7 @@ msgstr "" msgid "" "Here is the current default `avatar-animation.json " "`_ file." msgstr "" @@ -3285,7 +3285,7 @@ msgstr "" #: ../../source/create/avatars/find-avatars.rst:39 msgid "" "`Vircadia Avatar Exporter for Unity `_ (v0.4.1)" msgstr "" @@ -3313,7 +3313,7 @@ msgstr "" #: ../../source/create/avatars/find-avatars.rst:49 msgid "" "Download the `avatar exporter `_ from Vircadia." msgstr "" diff --git a/docs/source/locales/jp/LC_MESSAGES/explore.po b/docs/source/locales/jp/LC_MESSAGES/explore.po index b403bbaa..496e4128 100644 --- a/docs/source/locales/jp/LC_MESSAGES/explore.po +++ b/docs/source/locales/jp/LC_MESSAGES/explore.po @@ -3829,7 +3829,7 @@ msgstr "" #~ "code base. For more information, see " #~ "our `Linux Build Guide " #~ "`_." +#~ "athena/blob/master/BUILD_LINUX.md>`_." #~ msgstr "" #~ msgid "" diff --git a/docs/source/locales/jp/LC_MESSAGES/host.po b/docs/source/locales/jp/LC_MESSAGES/host.po index 6fc35f0d..25ec336d 100644 --- a/docs/source/locales/jp/LC_MESSAGES/host.po +++ b/docs/source/locales/jp/LC_MESSAGES/host.po @@ -3561,7 +3561,7 @@ msgid "" "run a local domain server on a Linux machine. To do so, you will need to " "build the application from our code base. For more information, see our " "`Linux Build Guide `_." +"athena/blob/master/BUILD_LINUX.md>`_." msgstr "" #: ../../source/host/server-setup/windows-server.rst:30 diff --git a/docs/source/locales/jp/LC_MESSAGES/release-notes.po b/docs/source/locales/jp/LC_MESSAGES/release-notes.po index e0e91a04..12e8f16a 100644 --- a/docs/source/locales/jp/LC_MESSAGES/release-notes.po +++ b/docs/source/locales/jp/LC_MESSAGES/release-notes.po @@ -2429,7 +2429,7 @@ msgid "" "The Vircadia Avatar Exporter for Unity has been updated to notify you of " "texture and file errors you may encounter while using the tool. Download " "the updated exporter here: https://github.com/kasenvr/project-" -"athena/tree/kasen/core/tools/unity-avatar-exporter" +"athena/tree/master/tools/unity-avatar-exporter" msgstr "" #: ../../source/release-notes/v80.md:37 ../../source/release-notes/v80.md:60 @@ -4152,7 +4152,7 @@ msgid "" "Introduced new build-time environment variable HIFI_VCPKG_BOOTSTRAP that " "will allow developers using Visual Studio 2019 to build the High Fidelity" " binaries. See the updated build guide for Windows here: " -"https://github.com/kasenvr/project-athena/blob/kasen/core/BUILD_WIN.md" +"https://github.com/kasenvr/project-athena/blob/master/BUILD_WIN.md" msgstr "" #: ../../source/release-notes/v84.md:46 diff --git a/docs/source/release-notes/v80.md b/docs/source/release-notes/v80.md index 68843e4e..64460630 100644 --- a/docs/source/release-notes/v80.md +++ b/docs/source/release-notes/v80.md @@ -32,7 +32,7 @@ Content Creators: From now on, **please use local entities instead of overlays** ### Avatars -* The Vircadia Avatar Exporter for Unity has been updated to notify you of texture and file errors you may encounter while using the tool. Download the updated exporter here: [https://github.com/kasenvr/project-athena/tree/kasen/core/tools/unity-avatar-exporter](https://github.com/kasenvr/project-athena/tree/kasen/core/tools/unity-avatar-exporter) +* The Vircadia Avatar Exporter for Unity has been updated to notify you of texture and file errors you may encounter while using the tool. Download the updated exporter here: [https://github.com/kasenvr/project-athena/tree/master/tools/unity-avatar-exporter](https://github.com/kasenvr/project-athena/tree/master/tools/unity-avatar-exporter) ### Create Tools diff --git a/docs/source/release-notes/v84.md b/docs/source/release-notes/v84.md index 1f8cb97a..792a46c7 100644 --- a/docs/source/release-notes/v84.md +++ b/docs/source/release-notes/v84.md @@ -42,7 +42,7 @@ Note: There is a protocol change in this version. * the list of created picks (Picks.getPicks()) * the properties that were given to a pick at time of creation (Picks.getPickScriptParameters(id)) * the current properties of a pick (Picks.getPickProperties(id)) -* Introduced new build-time environment variable HIFI_VCPKG_BOOTSTRAP that will allow developers using Visual Studio 2019 to build the High Fidelity binaries. See the updated build guide for Windows here: [https://github.com/kasenvr/project-athena/blob/kasen/core/BUILD_WIN.md](https://raw.githubusercontent.com/highfidelity/hifi/master/BUILD_WIN.md) +* Introduced new build-time environment variable HIFI_VCPKG_BOOTSTRAP that will allow developers using Visual Studio 2019 to build the High Fidelity binaries. See the updated build guide for Windows here: [https://github.com/kasenvr/project-athena/blob/master/BUILD_WIN.md](https://raw.githubusercontent.com/highfidelity/hifi/master/BUILD_WIN.md) * Updated High Fidelity's copyright on the About dialog. ## Fixes