Skip to content
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.

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

Add Designer section with draft color spec. #64

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions docs/source/design/color.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
#####
Color
#####

.. toctree::
:maxdepth: 1
:titlesonly:

Color Guidelines <color/guidelines>

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 47 additions & 0 deletions docs/source/design/color/guidelines.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
################
Color Guidelines
################

All UI/UX should try to follow the Material Design color specification as laid out `here <https://material.io/design/color/>`_.

-----------------
The Vircadia Logo
-----------------

The Vircadia colors are based off its primary logo variant:

+-------------------------------------------+------------------------------------------+
| Icon | Logo |
+===========================================+==========================================+
| .. image:: _images/vircadia-icon-128.png | .. image:: _images/vircadia-logo-564.png |
+-------------------------------------------+------------------------------------------+

-------------------
Primary Color Table
-------------------

+------------------+----------------------+---------+------------------+----------------------+---------+
| Dark Theme | Color | Code | Light Theme | Color | Code |
+==================+======================+=========+==================+======================+=========+
| Primary | red.green.blue | #434343 | Primary | red.green.blue | #434343 |
+------------------+----------------------+---------+------------------+----------------------+---------+
| Secondary | red.green.blue | #434343 | Secondary | red.green.blue | #434343 |
+------------------+----------------------+---------+------------------+----------------------+---------+
| Tertiary | red.green.blue | #434343 | Tertiary | red.green.blue | #434343 |
+------------------+----------------------+---------+------------------+----------------------+---------+
| Text | white | #FFFFFF | Text | Black | #000000 |
+------------------+----------------------+---------+------------------+----------------------+---------+
| Background | vircadia-navy-blue | #182b49 | Background | vircadia-navy-blue | #182b49 |
+------------------+----------------------+---------+------------------+----------------------+---------+

-----
Theme
-----

All UI/UX should have a **dark** and **light** theme for their entire layout. If the interface is in its early stages, a dark mode should take precedence because it is generally easier on the eyes for all situations.

------------------------------
Virtual Reality Considerations
------------------------------

As we get more dynamic and sleek UI experiences, it will make sense to deviate from the material design color specification's requirements in some areas. This document should be updated whenever such reviews take place.
15 changes: 15 additions & 0 deletions docs/source/designer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
########
Designer
########

----------------
Design Resources
----------------

Design resources such as guidelines, specifications, and tools can be found here.

.. toctree::
:maxdepth: 1
:titlesonly:

Color <design/color.rst>
16 changes: 8 additions & 8 deletions docs/source/developer.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
#########
Developer
#########
####################
Developer & Designer
####################

Developer information such as how to build the project from source, develop, or technically manage it can be found here.
---------------------
Development Resources
---------------------

------------------------
Development Instructions
------------------------
Developer information such as how to build the project from source, develop, or technically manage it can be found here.

.. toctree::
:maxdepth: 1
Expand All @@ -16,4 +16,4 @@ Development Instructions
Create an Installer <developer/installer.rst>
Interface <developer/interface.rst>
Domain Server <developer/domain-server.rst>
Assignment Client <developer/assignment-client.rst>
Assignment Client <developer/assignment-client.rst>
4 changes: 2 additions & 2 deletions docs/source/developer/build/BUILD_GENERAL.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
These dependencies need not be installed manually. They are automatically downloaded on the platforms where they are required.
- [Bullet Physics Engine](https://github.com/bulletphysics/bullet3/releases): 2.83
- [glm](https://glm.g-truc.net/0.9.8/index.html): 0.9.8
- [Oculus SDK](https://developer.oculus.com/downloads/): 1.11 (Win32) / 0.5 (Mac)
- [OpenVR](https://github.com/ValveSoftware/openvr): 1.11.11 (Win32 only)
- [Oculus SDK](https://developer.oculus.com/downloads/): 1.11 (Windows) / 0.5 (Mac)
- [OpenVR](https://github.com/ValveSoftware/openvr): 1.11.11 (Windows, Linux)
- [Polyvox](http://www.volumesoffun.com/): 0.2.1
- [QuaZip](https://sourceforge.net/projects/quazip/files/quazip/): 0.7.3
- [SDL2](https://www.libsdl.org/download-2.0.php): 2.0.3
Expand Down
19 changes: 13 additions & 6 deletions docs/source/developer/build/BUILD_OSX.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
# Build OSX

*Last Updated on April 30, 2019*
*Last Updated on July 3, 2020*

Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. Only macOS specific instructions are found in this document.

### Homebrew

[Homebrew](https://brew.sh/) is an excellent package manager for macOS. It makes install of some Vircadia dependencies very simple.

brew install cmake openssl
brew install cmake openssl npm

### Python 3

Download an install Python 3.6.6 or higher from [here](https://www.python.org/downloads/).
Execute the `Update Shell Profile.command` script that is provided with the installer.

### OSX SDK

You will need the OSX SDK for building. The easiest way to get this is to install Xcode from the App Store.

### OpenSSL

Assuming you've installed OpenSSL using the homebrew instructions above, you'll need to set OPENSSL_ROOT_DIR so CMake can find your installations.
For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR:

export OPENSSL_ROOT_DIR=/usr/local/Cellar/openssl/1.0.2l
For OpenSSL installed via homebrew, set OPENSSL_ROOT_DIR via
`export OPENSSL_ROOT_DIR=/usr/local/opt/openssl`
or by appending `-DOPENSSL_ROOT_DIR=/usr/local/opt/openssl` to `cmake`

Note that this uses the version from the homebrew formula at the time of this writing, and the version in the path will likely change.
### Xcode

If Xcode is your editor of choice, you can ask CMake to generate Xcode project files instead of Unix Makefiles.
Expand All @@ -34,3 +37,7 @@ If `cmake` complains about Python 3 being missing, you may need to update your C
After running cmake, you will have the make files or Xcode project file necessary to build all of the components. Open the hifi.xcodeproj file, choose ALL_BUILD from the Product > Scheme menu (or target drop down), and click Run.

If the build completes successfully, you will have built targets for all components located in the `build/${target_name}/Debug` directories.

### make

If you build with make rather than Xcode, you can append `-j4`for assigning more threads. The number indicates the number of threads, e.g. 4.
4 changes: 3 additions & 1 deletion docs/source/home.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ You have the power to shape your VR experience in Vircadia.
* :doc:`CREATE <create>` personal experiences by building avatars, domains, tablet apps, and more for you and others to enjoy.
* :doc:`SCRIPT <script>` and express your creativity by applying advanced scripting concepts to entities and avatars in the metaverse.
* :doc:`HOST <host>` and make immersive experiences to educate, entertain, and connect with your audience.
* :doc:`CONTRIBUTE <contribute>` to our endeavor by browsing our source code in the repository.
* :doc:`CONTRIBUTE <contribute>` to our endeavor by committing to the source code.
* :doc:`DESIGN <designer>` sleek UI/UX that is oriented towards comfort and usability.
* :doc:`DEVELOP <developer>` the project and tailor it to your needs, or just to help out.
* :doc:`SECURITY <security>` information about the project and its components.

Expand All @@ -32,6 +33,7 @@ You have the power to shape your VR experience in Vircadia.
SCRIPT <script>
HOST <host>
CONTRIBUTE <contribute>
DESIGNER <designer>
DEVELOPER <developer>
SECURITY <security>
FAQ <faq>
Expand Down