Skip to content

Feature/scripting info #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
two-one-five wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Feature/scripting info #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21f4e7b
Initial reference added.
digisomni Dec 1, 2020
303a8c7
Update references 'kasen/core' -> 'master'
digisomni Dec 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/create/applications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/create/avatars/custom-animations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ You can also override an existing animation role mapping:
1. Use `MyAvatar.getAnimationRoles <https://apidocs.vircadia.dev/MyAvatar.html#.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 <https://apidocs.vircadia.dev/MyAvatar.html#.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 <https://github.com/kasenvr/project-athena/tree/kasen/core/interface/resources/avatar/animations>`_.
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 <https://github.com/kasenvr/project-athena/tree/master/interface/resources/avatar/animations>`_.

+-------------------------------------------+----------------------------------------------------------------------+
| Animation Roles | Description |
Expand Down Expand Up @@ -227,7 +227,7 @@ OR
Examples
^^^^^^^^

+ Here is the current default `avatar-animation.json <https://github.com/kasenvr/project-athena/blob/kasen/core/interface/resources/avatar/avatar-animation.json>`_ file.
+ Here is the current default `avatar-animation.json <https://github.com/kasenvr/project-athena/blob/master/interface/resources/avatar/avatar-animation.json>`_ file.
+ This `scoot-animation.json <https://s3.amazonaws.com/hifi-public/tony/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.


Expand Down
4 changes: 2 additions & 2 deletions docs/source/create/avatars/find-avatars.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/kasenvr/project-athena/blob/kasen/core/tools/unity-avatar-exporter/avatarExporter.unitypackage?raw=true>`_ (v0.4.1)
+ `Vircadia Avatar Exporter for Unity <https://github.com/kasenvr/project-athena/blob/master/tools/unity-avatar-exporter/avatarExporter.unitypackage?raw=true>`_ (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.

Expand All @@ -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 <https://github.com/kasenvr/project-athena/blob/kasen/core/tools/unity-avatar-exporter/avatarExporter.unitypackage?raw=true>`_ from Vircadia.
1. Download the `avatar exporter <https://github.com/kasenvr/project-athena/blob/master/tools/unity-avatar-exporter/avatarExporter.unitypackage?raw=true>`_ from Vircadia.
2. In Unity, open the 'Project' window at the bottom.

.. image:: _images/project-window.png
Expand Down
2 changes: 1 addition & 1 deletion docs/source/developer/build/BUILD_LINUX.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/host/server-setup/windows-server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://vircadia.com/download-vircadia/#interface>`_ 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 <https://github.com/kasenvr/project-athena/blob/kasen/core/BUILD_LINUX.md>`_.
.. 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 <https://github.com/kasenvr/project-athena/blob/master/BUILD_LINUX.md>`_.


---------------
Expand Down
8 changes: 4 additions & 4 deletions docs/source/locales/de/LC_MESSAGES/create.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/kasenvr/project-"
"athena/tree/kasen/core/interface/resources/avatar/animations>`_."
"athena/tree/master/interface/resources/avatar/animations>`_."
msgstr ""

#: ../../source/create/avatars/custom-animations.rst:102
Expand Down Expand Up @@ -3071,7 +3071,7 @@ msgstr ""
msgid ""
"Here is the current default `avatar-animation.json "
"<https://github.com/kasenvr/project-"
"athena/blob/kasen/core/interface/resources/avatar/avatar-"
"athena/blob/master/interface/resources/avatar/avatar-"
"animation.json>`_ file."
msgstr ""

Expand Down Expand Up @@ -3287,7 +3287,7 @@ msgstr ""
#: ../../source/create/avatars/find-avatars.rst:39
msgid ""
"`Vircadia Avatar Exporter for Unity <https://github.com/kasenvr/project-"
"athena/blob/kasen/core/tools/unity-avatar-"
"athena/blob/master/tools/unity-avatar-"
"exporter/avatarExporter.unitypackage?raw=true>`_ (v0.4.1)"
msgstr ""

Expand Down Expand Up @@ -3315,7 +3315,7 @@ msgstr ""
#: ../../source/create/avatars/find-avatars.rst:49
msgid ""
"Download the `avatar exporter <https://github.com/kasenvr/project-"
"athena/blob/kasen/core/tools/unity-avatar-"
"athena/blob/master/tools/unity-avatar-"
"exporter/avatarExporter.unitypackage?raw=true>`_ from Vircadia."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion docs/source/locales/de/LC_MESSAGES/explore.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3829,7 +3829,7 @@ msgstr ""
#~ "code base. For more information, see "
#~ "our `Linux Build Guide "
#~ "<https://github.com/kasenvr/project-"
#~ "athena/blob/kasen/core/BUILD_LINUX.md>`_."
#~ "athena/blob/master/BUILD_LINUX.md>`_."
#~ msgstr ""

#~ msgid ""
Expand Down
2 changes: 1 addition & 1 deletion docs/source/locales/de/LC_MESSAGES/host.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/kasenvr/project-"
"athena/blob/kasen/core/BUILD_LINUX.md>`_."
"athena/blob/master/BUILD_LINUX.md>`_."
msgstr ""

#: ../../source/host/server-setup/windows-server.rst:30
Expand Down
4 changes: 2 additions & 2 deletions docs/source/locales/de/LC_MESSAGES/release-notes.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/source/locales/jp/LC_MESSAGES/create.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/kasenvr/project-"
"athena/tree/kasen/core/interface/resources/avatar/animations>`_."
"athena/tree/master/interface/resources/avatar/animations>`_."
msgstr ""

#: ../../source/create/avatars/custom-animations.rst:102
Expand Down Expand Up @@ -3069,7 +3069,7 @@ msgstr ""
msgid ""
"Here is the current default `avatar-animation.json "
"<https://github.com/kasenvr/project-"
"athena/blob/kasen/core/interface/resources/avatar/avatar-"
"athena/blob/master/interface/resources/avatar/avatar-"
"animation.json>`_ file."
msgstr ""

Expand Down Expand Up @@ -3285,7 +3285,7 @@ msgstr ""
#: ../../source/create/avatars/find-avatars.rst:39
msgid ""
"`Vircadia Avatar Exporter for Unity <https://github.com/kasenvr/project-"
"athena/blob/kasen/core/tools/unity-avatar-"
"athena/blob/master/tools/unity-avatar-"
"exporter/avatarExporter.unitypackage?raw=true>`_ (v0.4.1)"
msgstr ""

Expand Down Expand Up @@ -3313,7 +3313,7 @@ msgstr ""
#: ../../source/create/avatars/find-avatars.rst:49
msgid ""
"Download the `avatar exporter <https://github.com/kasenvr/project-"
"athena/blob/kasen/core/tools/unity-avatar-"
"athena/blob/master/tools/unity-avatar-"
"exporter/avatarExporter.unitypackage?raw=true>`_ from Vircadia."
msgstr ""

Expand Down
2 changes: 1 addition & 1 deletion docs/source/locales/jp/LC_MESSAGES/explore.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3829,7 +3829,7 @@ msgstr ""
#~ "code base. For more information, see "
#~ "our `Linux Build Guide "
#~ "<https://github.com/kasenvr/project-"
#~ "athena/blob/kasen/core/BUILD_LINUX.md>`_."
#~ "athena/blob/master/BUILD_LINUX.md>`_."
#~ msgstr ""

#~ msgid ""
Expand Down
2 changes: 1 addition & 1 deletion docs/source/locales/jp/LC_MESSAGES/host.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/kasenvr/project-"
"athena/blob/kasen/core/BUILD_LINUX.md>`_."
"athena/blob/master/BUILD_LINUX.md>`_."
msgstr ""

#: ../../source/host/server-setup/windows-server.rst:30
Expand Down
4 changes: 2 additions & 2 deletions docs/source/locales/jp/LC_MESSAGES/release-notes.po
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/release-notes/v80.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/release-notes/v84.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 7 additions & 1 deletion docs/source/script.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://apidocs.vircadia.dev/>`_.

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 <https://en.wikipedia.org/wiki/QtScript>`_ JavaScript engine.

Throughout this chapter, learn about the different types of scripts and how you can use them to create new experiences:

Expand Down