Table of Contents

1. Introduction
2. Install
3. Usage
4. Team
   • Product Owner
   • Programmers
   • Artists
5. Screenshots
6. Naming Conventions
   • 3D Files
   • Textures
7. Programming Style
   • Visual Appeal
   • Variable Prefixes
   • Using Properties
8. Contribute
9. License

Introduction

This Resort Visualizer prototype is being created for Pillar Workshop by students at Ferris State University. The goal of this project is to provide the client with a 3D web-based interactive visualizer. The visualizer will run on the WebGL JavaScirpt API and will be built in Unity 3D.

Install

This project uses Unity and WebGL. Go check them out if you don't have them locally installed.

Usage

Currently, this section is barren, as new features are built into the project this section will be updated.

Team

Product Onwer

Logan Armstrong
Email

Programmers

Kyle Andrews
Email

Artists

Brent Perko	Ed Chrzanowski	Cameron Ames	Brad Vriesman	Jole Striegle
Email	Email	Email	Email	Email

Screenshots

Currently, this section is barren, as new features are built into the project this section will be updated.

Naming Conventions

3D Files

Working Files:
(yyyy-mm-dd)_(ObjectName)_(Unwrapped (U) or NoUnwrap (NU))_(iteration #)_(initials of person who saved iteration).(obj or fbx)

Example:
2017-01-29_EiffelTower_NU_05_EC.obj

Textures

Working files:
(yyyy-mm-dd)_(ObjectName)_(initials of person who saved iteration).(texturing software)

Example :
2017-01-29_EifelTower_EC_.psd

Finals:
(Final)_(ObjectName)_(initials of person who saved iteration)_(mapname:DIFF,SPEC,NORM,etc.).png

Example:
Final_EifelTower_EC_DIFF.png

Programming Style

Visual Appeal

We will be following the standard naming conventions set by Microsoft's .NET Framework, see Programming Style below for specific changes.

Tabs over spaces, for this project we will be using four column tabs and the Allman indent style. All selection and iteration single-line statements will have a beginning and ending brace.

if(x == y) { return true; }

Variable Prefixes

All private variables will have an underscore prefix.

Using Properties

All global variables must declare their using properties and private variable counterparts.

private int m_numOfCows = 2;
public int g_numOfCows
{
    get
    {
        return m_numOfCows;
    }
}

We should never allow other scripts to set a public global variable, instead we’ll create a public function that sets the private variable.

public void SetNumOfCows(int newNumOfCows)
{
    m_numOfCows = newNumOfCows;
}

Contribute

Feel free to open an issue or clone this project to start working on your own, however, fixes and features contributions will only be accepted from Ferris State University students who are currently on the Resort Visualizer team.

License

Creative Commons Attribution-NonCommercial 4.0 International Public License (c) Ferris State University