We assume an iterative workflow where characters are put into game in their earliest/mockup phase and continuously updated as the projects progresses, bug surface and standards change late in production.
We assume an iterative workflow where characters are put into game in their earliest/mockup phase and continuously
updated as the projects progresses, bug surface and standards change late in production.
### Authoring
Characters are Modeled and Rigged in Maya and exported into FBX files.
### Prefabs
Prefab are where Materials are assigned and additional components for game play systems are added and configures.
Prefab are where Materials are assigned and additional components for game play systems are added and configured.
We use Prefab Variants as they allow the prefab to stay up to date as mesh, skeleton and skinning changes throughout production.
The Game class (Game.cs) is a MonoBehavior that defines the main loop of the game.
All gamecode is run from Game.cs Update method (with a few exceptions).
All gamecode is run from Game.Update method (with a few exceptions).
The game class can be requested to update a specific _GameLoop_ class.
The game class can be requested to update a specific _GameLoop_.
Gameloops implements various mode the game can be in.
They handle initialization and shutdown of required systems and updates systems in correct order.
Active gameloop can be changed at runtime.
## ServerGameLoop
ServerGameLoop (ServerGameLoop.cs) handles connection to a list of clients and update all server systems.
## ClientGameLoop.cs
## ClientGameLoop
This is used as a way to preview game without having to start up both server and client.
It uses a mix of server and client systems and that can lead to features not working correctly.
It uses a mix of server and client systems and is used as a way to preview game without building bundles and starting up server and client.
This is the gameloop that is used when user presses play in editor with a game scene loaded.
## Modules
Server and client have different ReplicatedEntityRegistry allowing for different prefabs to be spawned on server and client each representing the same entity (but they both need same set of serializable components)
Components that has data that should be replicated needs to implement the INetworkSerializable interface and be attacheds to same gameobject as ReplicatedEntity component.
To replicate an entity you need to create a scriptable object deriving from ReplicatedEntityFactory.
To replicate an ECS entity you need to create a scriptable object deriving from ReplicatedEntityFactory.
This class is also registered in ReplicatedEntityRegistry and has abstracts methods that needs to be implemented to create entity and create classes that serializes/deserializes component
### Player Module
### Character Module
Character module handles character abilities, animation and UI.
A character is define a prefab with either Character or Character1P MonoBehavior attached.
A character is define by prefab with either Character or Character1P MonoBehavior attached.
Characters are setup using the *CharacterTypeDefinition* scriptable object.
It has references to Server and Client versions of the 3P character prefab, and reference to the 1P prefab character that is instantiated in 1P view.
Characters are setup using the *CharacterTypeDefinition* scriptable object.
It has references to Server and Client versions of the 3P character, and reference to the 1P character that is instantiated in 1P view.
Each character is defined by 3 prefabs. Client version (3P), Server version (3P) and a 1P version.
The first two represents the client and server version of the same replicated entity.
Items are replicated but currently only client versions of prefabs have any logic or presentation.
Items are replicated but currently only client versions of prefabs have any logic or presentation.
When items are updated they read state of relevant abilities and uses that to trigger effects.
### Effect Module
Effect module is responsible for showing short clientside effects (gfx and sound).
Each effect is setup using a scriptable object (e.g. SpatialEffectTypeDefinition) that defines what prefab should be used for the effect and how large effect pool should be.
Effect are requested by gamecode by creating components (e.g SpatialEffectRequest) that are then picked up by effect systems and effct is triggered.
Effect are requested by gamecode by creating entities with request component (e.g SpatialEffectRequest) that are then picked up by effect systems and effct is triggered.
## Grenade Module
Grenade module handles creation and updating of grenades. Grenades is updated on server and interpolated on client.
Licensed under the Unity Companion License for Unity-dependent projects--see [Unity Companion License](http://www.unity3d.com/legal/licenses/Unity_Companion_License).
[network transport layer](https://github.com/Unity-Technologies/multiplayer) as well as the [Entity-Component System](https://unity3d.com/unity/features/job-system-ECS).
In the case of ECS, we have primarily adopted the "ECS-pattern" and use it in
hybrid mode with a lot of regular components. As more and more features of
Unity become availble in ECS-aware versions, we will migrate to them.
Unity become available in ECS-aware versions, we will migrate to them.
## Status and prerequisites
the following steps right after the initial import:
> 1. Search for `t:prefab` in the Project search field. Then click on the first prefab and shift+click on the last to select them all. Right click and select __Reimport__.
> 2. Search for `t:model` in the Project search field. Repeat the same steps as for prefabs to reimport them all.
> 3. __IF__ you are on a version older than beta 6, you may have had a few crashes during import. In that case you need to find `GooRocket` and `GooRifle` in project, right click and select __Reimport__.
>
> One day soon we will remove this note and there will be cake.
Now hit the green __Start__ button. This should launch two processes: one is
a standalone, headless server, the other is a client that will attempt to
connect to the server.
Congratulations! If you made it this far you should celebrate a bit!
## Development of FPS Sample, Contributions etc.
As of today, internally development of the project happens on Perforce. We
push versions of the project to github from there. As we do that we will update
the [CHANGELOG](CHANGELOG.md) with highlights but the full history is not
carried over.
For legal and practical reasons we are not able to take larger contributions
just now. We are working to see how we can make it happen and we are always happy
to hear about bugfixes and ideas for improvements in our forum. If you post
bugfixes, we remind you that they will be covered by
Peter Andreasen
6 年前