Mirrors/overte-thingvellir
3
0
Fork 0
mirror of https://thingvellir.net/git/overte synced 2025-03-27 23:52:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Removed the whitelist instructions as it is no longer enabled by default, we will add documentation for it at a later time.
This commit is contained in:
kasenvr 2020-02-14 12:10:35 -05:00 committed by GitHub
parent 78e3d65031
commit c14b0cd173
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -1,4 +1,17 @@
# Project Athena
# Project Athena
### What is this?
Project Athena is a 3D social software project seeking to incrementally bring about a truly free and open metaverse. (Desktop, VR, XR)
### [Download](https://projectathena.io/download-athena/)
### Releases
#### v0.86.0 K2 (TBD)
##### Features, Bugs, and Housekeeping
Check out the releases page for more information!
#### v0.86.0 K1 (12/3/19)
@ -9,48 +22,33 @@
* Entity Script Whitelist, no scripts are whitelisted by default.
* Background CMD outputs full log, instant close of application on closing of the CMD-line.
#### v0.86.0 K2 (TBD)
##### Features, Bugs, and Housekeeping
Check out the releases page for more information!
### Whitelist Instructions
The whitelist checks every entity-script attempting to run on your client against a list of domains, their subfolders, or the specific script URL entirely.
The Interface has the whitelist settings under "**Settings -> Entity Script Whitelist**" for you to configure live. The whitelist checks against the domains literally, so you have to be precise to ensure security and functionality. For example, the difference between "http://" and "https://" matters as those will be seen as two different domains in the eyes of the whitelist. Separate each URL by a new line.
Do not use spaces or commas in the whitelist interface, you will only separate by commas and not new lines in the environment variables.
You can also set the Windows environment variable "**EXTRA_WHITELIST**" with your whitelisted domains comma separated like so: "**http://mpassets.highfidelity.com/,https://raw.githubusercontent.com/highfidelity/,https://hifi-content.s3.amazonaws.com/**"
Alternatively you can make a batch file placed in the same folder as interface.exe that sets the whitelist environment variable temporarily:
```
set "EXTRA_WHITELIST=http://mpassets.highfidelity.com/,https://raw.githubusercontent.com/highfidelity/,https://hifi-content.s3.amazonaws.com/"
interface.exe
```
### How to build interface.exe
### How to build the Interface
[For Windows](https://github.com/kasenvr/project-athena/blob/kasen/core/BUILD_WIN.md)
[For Linux](https://github.com/kasenvr/project-athena/blob/kasen/core/BUILD_LINUX.md)
[For Linux - Athena Builder](https://github.com/daleglass/athena-builder)
### Boot to Metaverse: The Goal
Too many of us have our own personal combinations of High Fidelity from C++ modifications to different default scripts, all of which are lost to time as their fullest potential is never truly shared and propagated through the system.
Having a place to experience adventure, a place to relax with calm breath, that's a world to live in. An engine to support infinite combinations and possibilities of worlds without censorship and interruption, that's a metaverse. Finding a way to make infinite realities our reality, that's the dream.
The goal of this repo is to give a common area to PR the very best of our findings and creations so that we may effectively take each necessary step towards our common goal of living in a true metaverse.
### Boot to Metaverse: The Technicals
### Why High Fidelity's Engine?
Many developers have personal combinations of High Fidelity from C++ modifications to different default scripts, all of which are lost to time as their fullest potential is never truly shared and propagated through the system.
Because of all the options, it is the only starting point that is open-source, cross-platform, fully VR integrated + fully desktop integrated with an aim for quality visuals and performance. It also does us the service of providing a foundation to start from such as entity management, full body IK, etc.
The goal of this project is to achieve the metaverse dream through shared contribution and building. Setting goals that are achievable yet meaningful is key to making proper forward progress on the technical front whilst maintaining morale.
WebXR offers the open-source and decentralized aspect but does not have any of the full featured starting points such as avatars, IK, etc.
### Why High Fidelity's Virtual Reality Platform?
Platforms like NeosVR or VRChat are unusable from go due to their fundamental closed-source and centralized nature. A metaverse to live on cannot have the keys handed over to any one entity, if any at all.
Because of all the options, it is the only starting point that is open-source, cross-platform, fully VR integrated + fully desktop integrated with an aim for quality visuals and performance. It also provides a foundation to build from including components like entity management, full body IK, etc.
So the necessary desire is to use High Fidelity as our foundation as a community of one, of all to build a metaverse worth living in.
WebXR offers the open-source and decentralized aspect but does not have any of the full featured starting points such as avatars, IK, etc. which means that a lot of ground work will have to be laid to make something functional. Far more work will need to be done to create a truly seamless and extensive experience as well.
Platforms like NeosVR or VRChat are not viable from go due to their fundamental closed-source and centralized nature. A metaverse to live in cannot have the keys handed over to any singular entity, if any at all.
We need to do the best we can with what we've got and our best bet as open source developers is to not redesign the wheel if we can help it!
### Contribution