mirror of
https://github.com/JulianGro/overte.git
synced 2025-04-05 14:05:27 +02:00
Dale Glass
GitHub
commit
894a830ead
33 changed files with 232 additions and 271 deletions
|
|
@ -1,3 +1,9 @@
|
|||
# https://clang.llvm.org/docs/ClangFormat.html
|
||||
#
|
||||
# Copyright 2013-2019, High Fidelity, Inc.
|
||||
# Copyright 2022 Overte e.V.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
Language: Cpp
|
||||
Standard: Cpp11
|
||||
BasedOnStyle: "Chromium"
|
||||
|
|
|
|||
|
|
@ -1,6 +1,12 @@
|
|||
# https://editorconfig.org
|
||||
#
|
||||
# Copyright 2013-2019, High Fidelity, Inc.
|
||||
# Copyright 2022 Overte e.V.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
root = true
|
||||
|
||||
# 4-space indentation
|
||||
[*]
|
||||
indent_style = space
|
||||
indent_size = 4
|
||||
indent_size = 4
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
// https://eslint.org
|
||||
//
|
||||
// Copyright 2013-2019 High Fidelity, Inc.
|
||||
// Copyright 2020 Vircadia contirbutors
|
||||
// Copyright 2022 Overte e.V.
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
module.exports = {
|
||||
"root": true,
|
||||
"extends": "eslint:recommended",
|
||||
|
|
|
|||
6
.gitattributes
vendored
6
.gitattributes
vendored
|
|
@ -1,3 +1,9 @@
|
|||
# https://www.git-scm.com/docs/gitattributes
|
||||
#
|
||||
# Copyright 2013-2019 High Fidelity, Inc.
|
||||
# Copyright 2022 Overte e.V.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
*.cfg text
|
||||
*.cpp text
|
||||
*.css text
|
||||
|
|
|
|||
3
.github/CODEOWNERS
vendored
3
.github/CODEOWNERS
vendored
|
|
@ -1,2 +1,5 @@
|
|||
# Copyright 2022 Overte e.V.
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
# Require @JulianGro to review changed GitHub Actions workflows before they are run.
|
||||
/.github/workflows @JulianGro
|
||||
|
|
|
|||
11
.github/stale.yml
vendored
11
.github/stale.yml
vendored
|
|
@ -1,11 +0,0 @@
|
|||
# Number of days of inactivity before an issue becomes stale
|
||||
daysUntilStale: 180
|
||||
# Number of days of inactivity before a stale issue is closed
|
||||
daysUntilClose: false
|
||||
# Label to use when marking an issue as stale
|
||||
staleLabel: stale
|
||||
# Comment to post when marking an issue as stale. Set to `false` to disable
|
||||
markComment: >
|
||||
Hello! Is this still an issue?
|
||||
# Comment to post when closing a stale issue. Set to `false` to disable
|
||||
closeComment: false
|
||||
46
.github/workflows/dump.yml
vendored
46
.github/workflows/dump.yml
vendored
|
|
@ -1,46 +0,0 @@
|
|||
name: Dump Contexts
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
|
||||
jobs:
|
||||
one:
|
||||
strategy:
|
||||
matrix:
|
||||
os: [windows-latest, macOS-latest]
|
||||
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- name: Dump GitHub context
|
||||
shell: bash
|
||||
env:
|
||||
GITHUB_CONTEXT: ${{ toJson(github) }}
|
||||
run: echo "$GITHUB_CONTEXT"
|
||||
- name: Dump job context
|
||||
shell: bash
|
||||
env:
|
||||
JOB_CONTEXT: ${{ toJson(job) }}
|
||||
run: echo "$JOB_CONTEXT"
|
||||
- name: Dump steps context
|
||||
shell: bash
|
||||
env:
|
||||
STEPS_CONTEXT: ${{ toJson(steps) }}
|
||||
run: echo "$STEPS_CONTEXT"
|
||||
- name: Dump runner context
|
||||
shell: bash
|
||||
env:
|
||||
RUNNER_CONTEXT: ${{ toJson(runner) }}
|
||||
run: echo "$RUNNER_CONTEXT"
|
||||
- name: Dump strategy context
|
||||
shell: bash
|
||||
env:
|
||||
STRATEGY_CONTEXT: ${{ toJson(strategy) }}
|
||||
run: echo "$STRATEGY_CONTEXT"
|
||||
- name: Dump matrix context
|
||||
shell: bash
|
||||
env:
|
||||
MATRIX_CONTEXT: ${{ toJson(matrix) }}
|
||||
run: echo "$MATRIX_CONTEXT"
|
||||
5
.github/workflows/master_build.yml
vendored
5
.github/workflows/master_build.yml
vendored
|
|
@ -1,3 +1,8 @@
|
|||
# Copyright 2013-2019 High Fidelity, Inc.
|
||||
# Copyright 2020-2022 Vircadia contributors
|
||||
# Copyright 2021-2022 Overte e.V.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
name: Master CI Build
|
||||
|
||||
on:
|
||||
|
|
|
|||
3
.github/workflows/master_deploy_apidocs.yml
vendored
3
.github/workflows/master_deploy_apidocs.yml
vendored
|
|
@ -1,3 +1,6 @@
|
|||
# Copyright 2022 Overte e.V.
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
name: Master API-docs CI Build and Deploy
|
||||
|
||||
on:
|
||||
|
|
|
|||
3
.github/workflows/master_deploy_doxygen.yml
vendored
3
.github/workflows/master_deploy_doxygen.yml
vendored
|
|
@ -1,3 +1,6 @@
|
|||
# Copyright 2022 Overte e.V.
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
name: Master Doxygen CI Build and Deploy
|
||||
|
||||
on:
|
||||
|
|
|
|||
5
.github/workflows/pr_build.yml
vendored
5
.github/workflows/pr_build.yml
vendored
|
|
@ -1,3 +1,8 @@
|
|||
# Copyright 2013-2019 High Fidelity, Inc.
|
||||
# Copyright 2020-2022 Vircadia contributors.
|
||||
# Copyright 2021-2022 Overte e.V.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
name: Pull Request CI Build
|
||||
# Keep in mind that GitHub Actions does not allow reading secrets during PR builds.
|
||||
|
||||
|
|
|
|||
6
.gitignore
vendored
6
.gitignore
vendored
|
|
@ -1,3 +1,9 @@
|
|||
# https://www.git-scm.com/docs/gitignore
|
||||
#
|
||||
# Copyright 2013-2019 High Fidelity, Inc.
|
||||
# Copyright 2022 Overte e.V.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
VideoDecodeStats
|
||||
|
||||
# CMake
|
||||
|
|
|
|||
46
.grenrc.js
46
.grenrc.js
|
|
@ -1,46 +0,0 @@
|
|||
//
|
||||
// .grenrc.js
|
||||
//
|
||||
// Created by Kalila L. on May 25, 2021
|
||||
// Copyright 2021 Vircadia contributors.
|
||||
//
|
||||
// Distributed under the Apache License, Version 2.0.
|
||||
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
|
||||
//
|
||||
// This configuration is for generating a changelog with gren for a GitHub repository.
|
||||
// https://github.com/github-tools/github-release-notes
|
||||
//
|
||||
// gren changelog -G
|
||||
//
|
||||
|
||||
module.exports = {
|
||||
"dataSource": "prs",
|
||||
"prefix": "",
|
||||
"ignoreLabels": [
|
||||
"enhancement",
|
||||
"bugfix",
|
||||
"CMake",
|
||||
"unmerged-dev",
|
||||
"CR Approved",
|
||||
"QA Approved",
|
||||
"allow-build-upload",
|
||||
"bug",
|
||||
"confirmed",
|
||||
"do not merge",
|
||||
"duplicate",
|
||||
"good first issue",
|
||||
"help wanted",
|
||||
"hifi migration",
|
||||
"high risk",
|
||||
"rebuild",
|
||||
"merge right before snip"
|
||||
],
|
||||
"onlyMilestones": false,
|
||||
"groupBy": {
|
||||
"Enhancements": ["enhancement"],
|
||||
"Bug Fixes": ["bugfix"],
|
||||
"Docs": ["docs"],
|
||||
"In Development": ["unmerged-dev"]
|
||||
},
|
||||
"changelogFilename": "CHANGELOG.md"
|
||||
}
|
||||
7
BUILD.md
7
BUILD.md
|
|
@ -1,3 +1,10 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2020-2021 Vircadia contributors
|
||||
Copyright 2021-2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# General Build Information
|
||||
|
||||
*Last Updated on March 8, 2021*
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2019-2021 Vircadia contributors
|
||||
Copyright 2021-2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# Build Android
|
||||
|
||||
*Last Updated on December 15, 2020*
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2019-2022 Vircadia contributors
|
||||
Copyright 2021-2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# Build Linux
|
||||
|
||||
*Last Updated on January 6, 2022*
|
||||
|
|
|
|||
|
|
@ -1,39 +0,0 @@
|
|||
## This guide is specific to Ubuntu 16.04.
|
||||
|
||||
THIS DOCUMENT IS OUTDATED.
|
||||
|
||||
Deb packages of High Fidelity domain server and assignment client are stored on debian.highfidelity.com
|
||||
|
||||
```
|
||||
sudo su -
|
||||
apt-get -y update
|
||||
apt-get install -y software-properties-common
|
||||
apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 15FF1AAE
|
||||
add-apt-repository "deb http://debian.highfidelity.com stable main"
|
||||
apt-get -y update
|
||||
apt-get install -y hifi-domain-server
|
||||
apt-get install -y hifi-assignment-client
|
||||
```
|
||||
|
||||
When installing master/dev builds, the packages are slightly different and you just need to change the last 2 steps to:
|
||||
```
|
||||
apt-get install -y hifi-dev-domain-server
|
||||
apt-get install -y hifi-dev-assignment-client
|
||||
```
|
||||
|
||||
Domain server and assignment clients should already be running. The processes are controlled via:
|
||||
```
|
||||
systemctl start hifi-domain-server
|
||||
systemctl stop hifi-domain-server
|
||||
```
|
||||
|
||||
Once the machine is setup and processes are running, you should ensure that your firewall exposes port 40100 on TCP and all UDP ports. This will get your domain up and running and you could connect to it (for now) by using High Fidelity Interface and typing in the IP for the place name. (Further customizations can be done via http://IPAddress:40100).
|
||||
|
||||
The server always depends on both hifi-domain-server and hifi-assignment-client running at the same time.
|
||||
As an additional step, you should ensure that your packages are automatically updated when a new version goes out. You could, for example, set the automatic update checks to happen every hour (though this could potentially result in the domain being unreachable for a whole hour by new clients when they are released - adjust the update checks accordingly).
|
||||
To do this you can modify /etc/crontab by adding the following lines
|
||||
```
|
||||
0 */1 * * * root apt-get update
|
||||
1 */1 * * * root apt-get install --only-upgrade -y hifi-domain-server
|
||||
2 */1 * * * root apt-get install --only-upgrade -y hifi-assignment-client
|
||||
```
|
||||
|
|
@ -1,6 +1,13 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2020-2021 Vircadia contributors
|
||||
Copyright 2020-2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# Build macOS
|
||||
|
||||
*Last Updated on December 1, 2021*
|
||||
*Last Updated on September 8, 2022*
|
||||
|
||||
Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. This will include the necessary environment variables to customize your build. Only macOS specific instructions are found in this document.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2019-2021 Vircadia contributors
|
||||
Copyright 2021-2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# Build Windows
|
||||
|
||||
*Last Updated on 15 Apr 2021*
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<!--
|
||||
Copyright 2022 Overte e.V.
|
||||
SPDX-License-Identifier: MIT
|
||||
-->
|
||||
|
||||
# Changelog
|
||||
All notable changes to this project will be documented in this file.
|
||||
This does not include changes to unrelated to the software or its packaging,
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2020-2021 Vircadia contributors
|
||||
Copyright 2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# Coding Standards
|
||||
|
||||
Note that the current code base does not necessarily follow this with 100% consistency. It will be an ongoing process to try and sanitize the existing code to match these guidelines.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2020 Vircadia contributors
|
||||
Copyright 2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
The project embraces distributed development and if you'd like to help, it would be greatly appreciated. Just open a pull request with the revisions.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2020-2021 Vircadia contributors
|
||||
Copyright 2021-2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# Creating an Installer
|
||||
|
||||
*Last Updated on June 16, 2021*
|
||||
|
|
|
|||
73
LICENSES/Apache-2.0.txt
Normal file
73
LICENSES/Apache-2.0.txt
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
9
LICENSES/MIT.txt
Normal file
9
LICENSES/MIT.txt
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) <year> <copyright holders>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
@ -1,3 +1,10 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2019-2021 Vircadia contributors
|
||||
Copyright 2021-2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
<p align="center"><a href="https://overte.org/"><picture><source srcset="interface/resources/images/brand-banner.svg" alt="Overte" width="350" media="(prefers-color-scheme: dark)"><img src="interface/resources/images/brand-banner-black.svg" alt="Overte" width="350"></picture></a></p>
|
||||
|
||||
<h3 align="center"><a href="https://overte.org/">Website</a> | <a href="https://matrix.to/#/#overte:matrix.org">Matrix</a> | <a href="https://overte.org/#download">Download</a></h3>
|
||||
|
|
@ -12,6 +19,7 @@
|
|||
<p align="center">
|
||||
<a href="https://github.com/overte-org/overte/actions/workflows/master_build.yml"><img alt="Master CI Build" src="https://github.com/overte-org/overte/actions/workflows/master_build.yml/badge.svg"></a>
|
||||
<a href="https://github.com/overte-org/overte/actions/workflows/master_deploy_apidocs.yml"><img alt="API-docs CI Build & Deploy" src="https://github.com/overte-org/overte/actions/workflows/master_deploy_apidocs.yml/badge.svg"></a>
|
||||
<a href="https://api.reuse.software/info/github.com/overte-org/overte"><img alt="REUSE status" src="https://api.reuse.software/badge/github.com/overte-org/overte"></a>
|
||||
</p>
|
||||
|
||||
### What is this?
|
||||
|
|
|
|||
|
|
@ -1,88 +0,0 @@
|
|||
# THIS DOCUMENT IS OUTDATED
|
||||
|
||||
High Fidelity (hifi) is an early-stage technology lab experimenting with Virtual Worlds and VR.
|
||||
|
||||
This repository contains the source to many of the components in our
|
||||
alpha-stage virtual world. The project embraces distributed development.
|
||||
If you'd like to help, we'll pay you -- find out more at [Worklist.net](https://worklist.net).
|
||||
If you find a small bug and have a fix, pull requests are welcome. If you'd
|
||||
like to get paid for your work, make sure you report the bug via a job on
|
||||
[Worklist.net](https://worklist.net).
|
||||
|
||||
We're hiring! We're looking for skilled developers;
|
||||
send your resume to hiring@highfidelity.com
|
||||
|
||||
##### Chat with us
|
||||
Come chat with us in [our Gitter](https://gitter.im/highfidelity/hifi) if you have any questions or just want to say hi!
|
||||
|
||||
Documentation
|
||||
=========
|
||||
Documentation is available at [docs.highfidelity.com](https://docs.highfidelity.com/), if something is missing, please suggest it via a new job on Worklist (add to the hifi-docs project).
|
||||
|
||||
There is also detailed [documentation on our coding standards](CODING_STANDARD.md).
|
||||
|
||||
Contributor License Agreement (CLA)
|
||||
=========
|
||||
Technology companies frequently receive and use code from contributors outside the company's development team. Outside code can be a tremendous resource, but it also carries responsibility. Best practice for accepting outside contributions consists of an Apache-type Contributor License Agreement (CLA). We have modeled the High Fidelity CLA after the CLA that Google presents to developers for contributions to their projects. This CLA does not transfer ownership of code, instead simply granting a non-exclusive right for High Fidelity to use the code you’ve contributed. In that regard, you should be sure you have permission if the work relates to or uses the resources of a company that you work for. You will be asked to sign our CLA when you create your first PR or when the CLA is updated. You can also [review it here](https://gist.githubusercontent.com/hifi-gustavo/fef8f06a8233d42a0040d45c3efb97a9/raw/9981827eb94f0b18666083670b6f6a02929fb402/High%2520Fidelity%2520CLA). We sincerely appreciate your contribution and efforts toward the success of the platform.
|
||||
|
||||
Build Instructions
|
||||
=========
|
||||
All information required to build is found in the [build guide](BUILD.md).
|
||||
|
||||
Running Interface
|
||||
===
|
||||
When you launch interface, you will automatically connect to our default domain: "root.highfidelity.io".
|
||||
|
||||
If you don't see anything, make sure your preferences are pointing to
|
||||
root.highfidelity.io (set your domain via Cmnd+D/Cntrl+D). If you still have no luck,
|
||||
it's possible our servers are down. If you're experiencing a major bug, let us know by
|
||||
adding an issue to this repository. Include details about your computer and how to
|
||||
reproduce the bug in your issue.
|
||||
|
||||
To move around in-world, use the arrow keys (and Shift + up/down to fly up or
|
||||
down) or W A S D, and E or C to fly up/down. All of the other possible options
|
||||
and features are available via menus in the Interface application.
|
||||
|
||||
Running your own servers
|
||||
========
|
||||
The assignment-client and domain-server are architectural components that will allow
|
||||
you to run the full stack of the virtual world.
|
||||
|
||||
In order to set up your own virtual world, you need to set up and run your own
|
||||
local "domain".
|
||||
|
||||
The domain-server gives a number different types of assignments to the assignment-client
|
||||
for different features: audio, avatars, voxels, particles, meta-voxels and models.
|
||||
|
||||
Follow the instructions in the [build guide](BUILD.md) to build the various components.
|
||||
|
||||
From the domain-server build directory, launch a domain-server.
|
||||
|
||||
./domain-server
|
||||
|
||||
Then, run an assignment-client. The assignment-client uses localhost as its assignment-server
|
||||
and talks to it on port 40102 (the default domain-server port).
|
||||
|
||||
In a new Terminal window, run:
|
||||
|
||||
./assignment-client
|
||||
|
||||
Any target can be terminated with Ctrl-C (SIGINT) in the associated Terminal window.
|
||||
|
||||
This assignment-client will grab one assignment from the domain-server. You can tell the
|
||||
assignment-client what type you want it to be with the `-t` option. You can also run an
|
||||
assignment-client that forks off *n* assignment-clients with the `-n` option. The `-min`
|
||||
and `-max` options allow you to set a range of required assignment-clients. This allows
|
||||
you to have flexibility in the number of assignment-clients that are running.
|
||||
See `--help` for more options.
|
||||
|
||||
./assignment-client --min 6 --max 20
|
||||
|
||||
To test things out, you'll need to run the Interface client.
|
||||
|
||||
To access your local domain in Interface, open your Preferences. On OS X, this is available
|
||||
in the Interface menu. On Linux, you'll find it in the File menu. Enter "localhost" in the
|
||||
"Domain server" field.
|
||||
|
||||
If everything worked, you should see that you are connected to at least one server.
|
||||
Nice work!
|
||||
6
VCPKG.md
6
VCPKG.md
|
|
@ -1,3 +1,9 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
[VCPKG](https://github.com/Microsoft/vcpkg) is an open source package management system created by Microsoft, intially just for Windows based system, but eventually extended to cover Linux and OSX as well, and in theory extensible enough to cover additional operating systems.
|
||||
|
||||
VCPKG is now our primary mechanism for managing the external libraries and tools on which we rely to build our applications.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,9 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
Different libraries require different mechanism for building. Some are easiest with the standalone toolchain. Some are easiest with the ndk-build tool. Some can rely on CMake to do the right thing.
|
||||
|
||||
## Setup
|
||||
|
|
|
|||
|
|
@ -1,3 +1,10 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2021 Vircadia contributors
|
||||
Copyright 2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
# WebRTC
|
||||
|
||||
WebRTC Information:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
rem Copyright 2013-2019 High Fidelity, Inc.
|
||||
rem Copyright 2021 Vircadia contributors
|
||||
rem Copyright 2022 Overte e.V.
|
||||
rem SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
rem Copy this file to a directory above the WebRTC \src directory and run it from there in a command window.
|
||||
set WEBRTC_SRC_DIR=src
|
||||
set RELEASE_LIB_DIR=%WEBRTC_SRC_DIR%\out\Release\obj
|
||||
|
|
|
|||
|
|
@ -1,2 +1,8 @@
|
|||
<!--
|
||||
Copyright 2013-2019 High Fidelity, Inc.
|
||||
Copyright 2022 Overte e.V.
|
||||
SPDX-License-Identifier: Apache-2.0
|
||||
-->
|
||||
|
||||
These are our own custom controls with the same names as existing controls, but
|
||||
customized for readability / usability in VR.
|
||||
|
|
|
|||
|
|
@ -1,39 +0,0 @@
|
|||
tools
|
||||
=========
|
||||
|
||||
Various command line tools for interacting with the Voxel Server and Interface.
|
||||
|
||||
objtohio.php :
|
||||
|
||||
USAGE:
|
||||
php objtohio.php -i 'inputFileName' -o 'outputFileName' -m [blocks|wireframe|surface] -s [voxel size]
|
||||
|
||||
DESCRIPTION:
|
||||
Converts a Wavefront OBJ file into a voxel binary file suitable for loading locally into the client or
|
||||
loading on the voxel server or sending to the voxel server using sendvoxels.php
|
||||
|
||||
NOTE:
|
||||
Depending on the size of the model, it might take a lot of memory, so you will likely need to include
|
||||
the -d memory_limit=4096M option
|
||||
|
||||
EXAMPLE:
|
||||
|
||||
php -d memory_limit=4096M objtohio.php -i "Samples/little girl head-obj.obj" -o girl-test.hio -s 0.006
|
||||
|
||||
|
||||
sendvoxels.php :
|
||||
|
||||
USAGE:
|
||||
sendvoxels.php -i 'inputFileName' -s [serverip] -p [port] -c [I|R]
|
||||
|
||||
DESCRIPTION:
|
||||
Sends the contents of a voxel binary file to a voxel server. Can either Insert or Remove voxels. Command defaults
|
||||
to "I" insert.
|
||||
|
||||
EXAMPLES:
|
||||
|
||||
php sendvoxels.php -s 192.168.1.116 -i 'girl-test.hio' -c I
|
||||
php sendvoxels.php -s 192.168.1.116 -i 'girl-test.hio' -c R
|
||||
php sendvoxels.php -s 192.168.1.116 -i 'girl-test.hio'
|
||||
|
||||
|
||||
Loading…
Reference in a new issue