"Project Athena" Applications Repository
-This repository stores the optional tablet's applications and functionalities provided by the contributions of the community members. - If you have created an Application or functionality and want to offer it to the community, this is where you can do it.
+Vircadia Community Applications Repository
+This repository stores optional tablet applications and functionalities provided by the contributions of the community members. + If you have created an Application or functionality script and want to offer it to the community, this is where you can do it.
Before going further:
-
-
- If your application/functionality is a core feature that you think that required being delivered out-of-the-box with "Project Athena", you must instead consider making your contribution directly in the "Project Athena" code line. See instead the Project Athena repository and contact their maintainers.
- If your application/functionality has any dependency with an external server or services. (If it has to deal in any ways with other servers than a Project Athena Domain or Metaverse API) This repository is not where you should publish your application. It will have to be published from a different source like the Marketplace (when it will exist) or another web site. +
- If your application/functionality is a core feature that you think should be delivered out-of-the-box with Vircadia, you must instead consider making your contribution directly in the Vircadia code repository. See instead the Vircadia repository and contact the core team.
- If your application/functionality has a dependency with on an external server or services (if it has to deal in any ways with other servers than a Vircadia Domain or Metaverse API), then this repository is not where you should publish your application. It will have to be published to a different source like the Marketplace (when it is created) or another web site.
-
+
Conditions for acceptance:
-
-
- You must include in your script a license reference making your script fully open source:
+ - You must include a license reference in your files to make your script fully open source:
// Distributed under the Apache License, Version 2.0.
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
- Avoid spaces and special characters in your folders and file names.
(Stay with: "a-z", "A-Z", "0-9", "-", "_", ".") - Add your application/functionality in a folder under the "applications" directory.
+ - Add your application/functionality in a folder under the "applications" directory.
(Your main js file and your icon must be directly in that folder) - You must add your application/functionality to the "metadata.js" file (in the "applications" directory) by generating a new one using this tool: Metadata Generator +
- You must add your application/functionality to the "metadata.js" file (in the "applications" directory) by generating a new one using this tool: Metadata Generator
-
-
Submit a "Pull Request" to add your "application folder" and the new "metadata.js" file.
- (If you are not comfortable with those procedures, contact Keb Helion on "Project Athena" Discord.)
Guidelines for the code reviewer:
-
-
- Test the applications in the "Project Athena".
- Make sure that the JSON and Javascript contained in "metadata.js" are valid before accepting the commit. !!! This will be directly in production once committed. !!!
- Test the "More..." application in the "Project Athena" after having done: "Edit > Reload Content (Clears all caches)", and at least 5 minutes after the commit. +
- Test the applications in Vircadia.
- Make sure that the JSON and Javascript contained in "metadata.js" are valid before accepting the pull request! This will affect the production "More" application immediately for all users.
- Test the "More..." application in Vircadia.
-
-
+
+