Getting Started
Welcome Pop-up
On first adding NeoFPS to your project, once the assets have been imported, you should see the following pop-up appear.
This pop-up will notify you of any changes to the required settings that must be applied (for more information see NeoFPS Installation). It also provides a quick way of accessing the sample scenes along with helpful links for getting the most from NeoFPS;
The welcome pop-up will only be shown automatically this first time. If you want to see it again then it can be found in the toolbar via Tools/NeoFPS/Show Welcome. Alternatively you can check the Show welcome popup on startup checkbox at the bottom of the pop-up and it will be shown each time the project is loaded.
Project Structure
All NeoFPS assets are contained in the NeoFPS folder. Inside this there are 3 subfolders:
- Constants contains all the Generated Constants used by NeoFPS and its samples.
- Core contains all the code and assets required by NeoFPS.
- Samples contains a number of sample assets and scenes that demonstrate the different features.
Samples
There are a number of sample assets and scenes that demonstrate the different features in NeoFPS and provide a reference for implementing your own contents and mechanics. For more information, see Samples.
Using NeoFPS In Your Game
The quickest way to start prototyping in NeoFPS is to drop the TestSetup prefab in your scene. This prefab can be found at the following location:
Assets\NeoFPS\Samples\SinglePlayer\Prefabs\TestSetup.prefab
The test setup prefab contains a minimal game mode and a spawn point, and references the sample player and controller prefabs. For more information, see Game Modes and FPS Characters.
To add environmental features to your scene, see Layers and Tags for details on what layers to use for environmental geo and Surfaces to add surface audio and impact effects.
For information on how to set up weapons for your game, see Weapons.
To add interaction to your game such as switches, doors and puzzles, see Interaction.
To add your own characters or customise the sample character, see FPS Characters.
NeoFPS is also designed to be extended to suit your vision. Each of the features is implemented in such a way that it can be replaced or expanded. For more information see Extending NeoFPS.