First Person Exploration Kit: Documentation

[FPE Kit Logo]

Latest Version

The latest version is available in the Unity Asset Store.

Download the demo for Windows (alternate download host), or watch a detailed walkthrough on youtube.

All demo scenes are included in the package.


Get the latest documentation update online



Overview

First Person Exploration Kit is a complete package to create a First Person Environmental Exploration or Adventure game.


Table of Contents


    General Information
  1. Tutorial Videos
  2. Frequently Asked Questions
  3. Release Notes

  4. Upgrading (for existing users of version 1.2)
  5. Migrating your project from v1.2 to 2.0
  6. Summary of Technical Changes (source code and class structures) from v1.2 to v2.0

  7. Getting Started - The Basics
  8. Getting Started
  9. Custom Gizmo Icons
  10. Creating a Pickup
  11. Creating a Journal
  12. Creating an Audio Diary
  13. Creating a Note
  14. Creating a Passive Audio Diary
  15. Creating a Static Interaction
  16. Creating an Inventory Item

  17. Getting Started - More Advanced Interactions
  18. Overview of Activate Type Interactions
  19. Creating a Basic Toggle (Light Switch)
  20. Creating a Simple Door
  21. Creating a Basic Player 'Dock' (An Armchair)
  22. Creating an Event Trigger
  23. Creating a Doorway to Another Level (Scene)

  24. Technical Details
  25. Systems Overview (prefabs, key scripts, etc.)
  26. Input System
  27. Input Definitions
  28. Tags, Layers, and Physics
  29. Interaction Types
  30. Inventory Items
  31. Player Configuration
  32. Save Game System
  33. Saving and Loading UI
  34. Gameplay UI
  35. Gameplay UI Details
  36. Menus (Main Menu, Game Menu)

  37. Customization and Other
  38. Sound Guide
  39. Graphics Guide
  40. General Package Notes

If you have any problems using this package, or have tweaks or new features you'd like to see included, please email me with the details.

Thanks,
Richard



Tutorial Videos

A series of tutorial videos is available on youtube playlist here.


Frequently Asked Questions

Q: I have changed some of the source code that was in the previous version. Will my changes be overwritten when I upgrade?

A: YES! Your changes will be overwritten. Please be sure to back up your project before upgrading. Refer to the migration guide for detailed steps on upgrading your project: Migrating your project from v1.2 to 2.0


Q: Is there a bullet proof way to modify the existing source code to ensure future upgrades will never break my project?

A: No. BUT, you can do things like extend existing 'FPE' classes, which will help. I will always try to avoid "breaking changes" to the core code, but cannot guarantee it. It is best to make note off all changes you make to the source code. You can do this with code regions, comments, track them in a text file, etc.


Q: Is this asset package compatible with other player controllers like UFPS?

A: Not out of the box, no. Some customization is required. Please refer to the Player Configuration documentation.


Q: Does First Person Exploration Kit work in VR?

A: Not really, no. You could port it to work in VR, but it was not designed with VR in mind. As a result, much of the UI and interaction methods won't work the same way in VR. For example, the screenspace UI will not work with stereoscopic cameras. And actions like examining objects require the player movement and view are locked, which is not really good practice in VR.


Q: What are the license terms of this asset? Can I ship it in commercial games and applications?

A: Absolutely you can. BUT, you cannot re-sell or re-distribute the source code or raw 'asset package' in any form. Basically, the thing you ship must be an executable, not an editable "Unity Project". Please refer to the Unity Asset Store terms of service.


Q: Why does this asset cost so much?

A: Depending on your skill level and comfort with Unity, this asset will save you tens to hundreds of hours of development time. The price is designed to be fair for what the asset provides, without freezing out indies or hobbyists. It is important to me that the asset remains affordable, while also providing enough return so I can contiue to support and maintain it.





Disclaimer

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.