Skip to content

Commit

Permalink
converted project into Unity Package.
Browse files Browse the repository at this point in the history
  • Loading branch information
TheDudeFromCI committed May 29, 2020
1 parent b8ff412 commit c1b92ea
Show file tree
Hide file tree
Showing 80 changed files with 205 additions and 38 deletions.
9 changes: 0 additions & 9 deletions Assets/Wraithaven Games/FirstSight/DEMO/Materials.meta

This file was deleted.

9 changes: 0 additions & 9 deletions Assets/Wraithaven Games/FirstSight/DEMO/Prefabs.meta

This file was deleted.

9 changes: 0 additions & 9 deletions Assets/Wraithaven Games/FirstSight/DEMO/Scenes.meta

This file was deleted.

1 change: 1 addition & 0 deletions Packages/manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"dependencies": {
"com.unity.ide.vscode": "1.2.1",
"com.unity.upm.develop": "0.1.2-preview",
"com.unity.modules.ai": "1.0.0",
"com.unity.modules.androidjni": "1.0.0",
"com.unity.modules.animation": "1.0.0",
Expand Down
12 changes: 12 additions & 0 deletions Packages/net.wraithavengames.firstsight/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Changelog

All notable changes to this package will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [1.0.0] - 2020-05-28

### This is the first release of _FirstSight_.

Created package, physics support, camera effects, and footstep effect.
7 changes: 7 additions & 0 deletions Packages/net.wraithavengames.firstsight/CHANGELOG.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# About First Sight

The First Sight package includes a set of out-of-the-box first person character controller scripts which should apply to most standard uses of first person controller scripts.

These scripts are highly customizable and should adapt nicely to fit the needs of your project. Some of these features include sprinting, camera impact shaking, footsteps, and physics object pushing.

# Installing First Sight

To install this package, follow the instructions in the [Package Manager documentation](https://docs.unity3d.com/Packages/com.unity.package-manager-ui@latest/index.html).

# Using First Sight

First Sight requires a game object, representing the player, to have a Character Controller, a Player Controller, a Mouse Controller, and an Input Settings script to be added to it. Another game object with the camera behaviour should be a child of this object, places at the position of the head of the character. The settings of these scripts should be filled out depending on the needs of your project.

After this, any additional features can be added to the player by adding more behaviors on the player game object. For additional information on behaviours, see **Behavior Scripts** below.

# Technical details

## Requirements

This package has no additional requirements.

## Package contents

### Behavior Scripts

**Screen Shake**
Can be used to add a small screen shake effect to the camera when the player receives an impact. By default, this script only handles fall damage based impacts, but exposes a public method which can be called from other scripts for events such as being damaged by an enemy.

**Footsteps**
You can use this script, along with an attached audio source, to play footstep founds as you walk. It takes in a set of audio files and plays them in sync with your player's walking speed in an alternating fashion.

**Sprint FOV**
This script automatically adjusts the camera field of view based on the player's speed. Namely, when the player sprints.

**Push Objects**
This script give the player the ability to push physics based object by walking into them.

### Prefabs

To speed up the getting-started process, a prefab for a default player controller can be found in the prefab folder. This contains a set of commonly use movement behaviors at their default settings.

In addition, a cross hairs UI canvas prefab prefab exists as a placeholder while if you are still working on a user interface. The can also be found under the prefab folder. It contains a simple Unity UI canvas object, with a small sprite in the middle of the screen.

## Document revision history

| Date | Reason |
| ------------ | ------------------------------ |
| May 28, 2019 | Initial documentation written. |
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
using UnityEngine;
using UnityEditor;

namespace WraithavenGames.FirstSight
namespace WraithavenGames.FirstSight.Editor
{
[CustomEditor(typeof(PlayerController))]
public class PlayerControllerEditor : Editor
public class PlayerControllerEditor : UnityEditor.Editor
{
override public void OnInspectorGUI()
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "WraithavenGames.Firstsight.Editor",
"references": [
"WraithavenGames.Firstsight"
],
"includePlatforms": [
"Editor"
],
"excludePlatforms": [],
"allowUnsafeCode": false,
"overrideReferences": false,
"precompiledReferences": [],
"autoReferenced": true,
"defineConstraints": [],
"versionDefines": [],
"noEngineReferences": false
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 21 additions & 0 deletions Packages/net.wraithavengames.firstsight/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 TheDudeFromCI

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.
7 changes: 7 additions & 0 deletions Packages/net.wraithavengames.firstsight/LICENSE.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions Packages/net.wraithavengames.firstsight/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# First Sight

First Sight is a out-of-the-box first person controller script for Unity. Complete with full physics support, camera shake/fov effects, footstep support, sprinting and object pushing, it should suite as a nice foundation for most projects to build off of.
7 changes: 7 additions & 0 deletions Packages/net.wraithavengames.firstsight/README.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "WraithavenGames.Firstsight",
"references": [],
"includePlatforms": [],
"excludePlatforms": []
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"displayName": "Simple FPS Scene",
"description": "An example scene showing off the movement mechanics of FirstSight.",
"createSeparatePackage": true
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 23 additions & 0 deletions Packages/net.wraithavengames.firstsight/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "net.wraithavengames.firstsight",
"displayName": "FirstSight",
"version": "1.0.0",
"unity": "2019.3",
"description": "A first person controller module with physics and effects support.\nContains:\n- Physics friendly Movement\n- Footstep Sounds\n- Object Pushing\n- Dynamic FOV\n- Camera Shake on Impact\n- etc",
"hideInEditor": false,
"keywords": [
"first person",
"controller",
"character",
"fps",
"camera",
"first",
"person",
"physics"
],
"author": {
"name": "TheDudeFromCI",
"email": "[email protected]",
"url": "https://github.com/Wraithaven-UnityTools/FirstSight"
}
}
7 changes: 7 additions & 0 deletions Packages/net.wraithavengames.firstsight/package.json.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# First Sight
First Sight is a drop-and-play first person controller script for Unity. Complete with support for camera effects, footstep sounds, basic physics, and other common features which are in high demand for many Unity projects.

Importable Unity packages can be found in the Actions tab, under build artifacts.
First Sight is a out-of-the-box first person controller script for Unity. Complete with full physics support, camera shake/fov effects, footstep support, sprinting and object pushing, it should suite as a nice foundation for most projects to build off of.

0 comments on commit c1b92ea

Please sign in to comment.