Universal Fighting Engine

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Network Options =====
UFE 2 comes with a completely revision of its core physics and network mechanics. The second iteration allows you to run online matches in a smooth lag-free environment thanks to its native //rollback mechanics// (similar to [[https://en.wikipedia.org/wiki/GGPO|GGPO]]) and //deterministic physics//. The netcode also uses raw //manual tracking// to its own variables, optimizing CPU usage (including mobile devices).\\
The new network options also comes with its own client/server structure (using Photon Network or UNet) allowing direct player connection without the use of IP.

For detailed instructions on UFE 2 Netcode and how to convert your previous UFE 1.x project, [[global:netcode|click here]].

----

{{ :global:global_networkoptions.png |}}


----
==== Setup ====
You need **UFE 2 Standard/PRO/Source** and [[https://assetstore.unity.com/packages/tools/network/pun-2-free-119922|PUN2]] to use this feature. 

1- Sign up for free at [[https://www.photonengine.com/en/PUN]]. You will be asked to setup the App ID. You can find it under ''Public Cloud -> Applications'' inside your account page. Copy your App ID as displayed on the web page (example):
{{ :global:netcode_photonaccount.jpg?nolink |}}

2 - Download and unpack the photon package under your UFE project, and under ''\Photon\PhotonUnityNetworking\Resources\PhotonServerSettings'', paste your App ID under ''Server/Cloud Settings -> App Id PUN'':
{{ :global:netcode_photonadditionaloptions.png?nolink |}}

3 - Now, extract the files at ''UFE\Engine\ThirdPartySupport\Photon2APIConnector.unitypackage'' to connect UFE and Photon. If everything worked, you will notice the [[global:network|Network Options]] under Global Editor is now unlocked. Go to //Online Service// and set Photon as your Network service. Hit play and you should see the Network option enabled.


You can also set a variety of connection options with the Photon Server Settings such as protocol used, hosting type and search by separated search regions. For more information visit [[https://doc.photonengine.com/en-us/pun/current/getting-started/initial-setup|this link]].


----
==== Online Service ====

**Network Service:** Choose which online server to use. If you wish to use Unity (up to Unity version 2018) you must have a [[http://developer.cloud.unity3d.com|Developer Profile]] with access to Multiplayer. You must then connect your Unity to your profile via ''Window -> Services''. For Photon, follow the instructions above.\\
For more on deterministic network take a look at [[global:netcode|this tutorial]].

**Photon Service: ** (Photon Only) Choose which cloud service to be used in conjunction with [[https://doc.photonengine.com/en-us/pun/current/getting-started/initial-setup|Photon]].


----
==== Particle Control ====

**Control Spawned Particles:** When toggled, UFE will search for possible particle effects coming from a spawned game object (either being a [[move:projectiles|projectile]], [[global:hiteffects|hit effect]], or just a spawned [[move:particleeffects|particle effect]]) and control its random seed and speed for when the game pauses or rolls back.

**Sync Random Seed:** Override the [[https://docs.unity3d.com/ScriptReference/ParticleSystem-randomSeed.html|random seed]] used for the Particle System emission.

**Override Simulated Speed:** Override the default [[https://docs.unity3d.com/ScriptReference/ParticleSystem.MainModule-simulationSpeed.html|playback speed]] of the Particle System.


----
==== Animation Control ====

**Fake Network:** Toggle to run local network packaging tests. It forces local PvP matches to emulate a network game. Useful to test the Netcode without running 2 clients.

**Force UFE Animation Control:** UFE Netcode works by forcing a full synchronization between 2 clients. To ensure there are no desyncs, toggle this option to make it so the UFE Engine is always in charge of the [[character:movesets|animation control]] during online matches regardless of your offline options.

**Disable Blending:** Override all animation blending states to be 0. Using this feature helps you "mask" the times there is a rollback as it needs to refresh the animation component.

**Disable Rotation Blend:** (Mecanim only) Override the blending done during rotation to 0.


----
==== Package Options ====

**Network Message Size:** How big should the package be. If your game only uses 4 buttons, use 8 bits. Use 16 bits for more than 4, and 32 bits if you plan to use more than 12 buttons or if you need to send different data through the same broadcast system (such as debug logs or sync checks).

**Broadcast Frequency:** How often should the network attempt to send changes to the inputs? The higher the frequency, the more bandwidth is used.

**Only Send Input Changes:** If enable, the network will only send data that has been changed (instead of sending every broadcast frequency tick)


----
==== Rollback Netcode ====

**Available only on PRO and Source licenses**

**Allow Rollbacks:** Enable Rollbacks in your game (Make sure you've gone through [[global:netcode|setup]]).

**Max Fast-Forward Per Frame:** When using rollback, depending on the distance between packages sent, how many frames can your game recover from. The more frames, the more CPU power it needs.

**Input Buffer Size:** The amount of inputs that can be stored and reproduced in case of a rollback.

**Spawn Buffer Size:** The amount of game objects that can be stored in a "safe pool" before they get //garbage collected//. Adjust this value based on the amount of object spawns (effects, projectiles, etc) you have at once in your game.

**Rollback Balancing:** Use this option to balance out the rollback experience between the players.
  * //Disabled:// Only one of the players feels the effects of rollback. The host (or player with better connection) plays the game like there is nothing wrong.
  * //Conservative:// One player feels the effects of rollback more often the other.
  * //Aggressive:// Both players share the same impact when a rollback is needed to stabilize the connection. Use this option to "share" the impact of a rollback between players (recommended).

**Track UFE Variables (disabled):** Toggle so UFE will use the //auto tracking// technique to search for its interface (''UFEInterface'') and attributed variables (''RecordVar'') on its own instantiated classes. The deeper a variable is from the UFE instance, the more CPU power it consumes.


----
==== Frame Delay Netcode ====

**Frame Delay Type:** If set to ''Auto'', UFE will determine based on the ping what frame delay better fits the match. if you plan to toggle ''Apply Frame Delay Online'', use ''Fixed'' instead for a better user experience.

**Min Frame Delay:** When connection is //ideal// (<10ms ping) what is the best value for //minimum// input delay in your game? Large values makes the game more tolerant to lag spikes. On ideal connections it's recommended that you leave at least 4 frames (for 60 fps) or 3 (for 30 fps) - according to your [[global:advanced|FPS structure]].\\
If you are using Rollback, the game will always attempt to use this value. Games less dependent on animation blending (such as 2D) can try for lower values, while games more dependent on hardware optimization (or better visual fidelity) should try for higher.

**Max Frame Delay:** In case of bad connections, how far should the input delay before increase before it relies on rollback to keep the network packages synchronized?

**Apply Frame Delay Offline:** Makes it so every game (including CPU matches and Training Mode) are always running with the ''Min Frame Delay'' value.


----
==== Synchronization Test ====

If you are making modifications to the source code, specially the core files, there is a chance you could cause an accidental desynchronization. Don't worry, UFE offers plenty of tools for you to try detecting what went wrong.

**Set Host As AI:** When toggled, while testing online matches, the person who //hosts// the game will have its inputs overwritten by AI controls.

**Set Client As AI:** When toggled, while testing online matches, the person who //joins// the game will have its inputs overwritten by AI controls.

**Desync Action:** If the game desyncs, what should happen?
  * Disabled: Nothing happens, the game continues differently for both players.
  * Playback Tool: The game pauses on both players and the replay tool is enabled. You will see 2 recording states: One that shows what the player saw and one that shows what happened after the rollback was applied (standard gameplay). Use this tool to compare and detect what could have gone wrong. You can also generate data logs to better identify the problem. For more information check out this [[https://www.youtube.com/watch?v=j3B-lhd8JBw|video]].
  * Disconnect: If the game desyncs, both players are disconnected from the match.

**Float Desync Threshold:** When the playback tool or disconnect option is selected, UFE will attempt to compare certain data values every frame cycle (defined bellow) in order to catch the desync as soon as possible.

**Log Sync Messages (Console):** If toggled, UFE will report every successful sync check in the console window.

**Record Post-Rollback Frames:** If toggled, UFE will record a second set of frames with the post-rollback process allowing you to see what happened in between rollback frames in the recording.

**Generate Variable Log:** If toggled, UFE will generate a variable log that you can compare between the 2 clients.

**Exported File Path:** The path the variable log above will be created.

**Recording Buffer:** How many frames should be recorded for comparing.


----
===== Bluetooth =====
If you plan on having your game running on Android devices you might want to set a bluetooth connection using [[https://assetstore.unity.com/packages/tools/network/simple-bluetooth-for-android-140551|Simple Bluetooth for Android]] available on the Asset Store.\\
To install it, once you import the asset, navigate go to ''.UFE\Engine\ThirdParty''. And unpack ''BluetoothConnector.unitypackage''. If it worked, you should see the following message under Network Options -> General: ''Bluetooth installed''.

In order to test it, go to [[global:gui|GUI Options]] and under //Screens//, replace the current Main Menu UI with the alternative ''MainMenuScreenBluetooth.prefab'' (located under ''UFE\Demo\GUI\UI Prefabs\'').\\
You should also see the option ''Bluetooth Game'' under the Network Mode group as well. Drag the ''BluetoothGameScreen.prefab'' to that field if its not there already.

{{ :global:bluetoothscreens.jpg?nolink |}}

Export your game to 2 Android devices and there you have it. Just select the bluetooth option and begin fighting!


----
====== Hints ======
Networking is a relatively complicated aspect of the engine. Don't be alarmed if you can't get running at first. Here are a few hints to help out on common issues:
  * If you are experiencing lag, try changing the hosting option and protocol under 'PhotonServerSettings'. For more information on Photon options, [[https://doc.photonengine.com/en-us/pun/current/getting-started/initial-setup|click here]].
  * Make sure you have no 'self-destruct' scripts attached to your particle effects. UFE needs to control the spawn and despawn of every GameObject. If you need to use one, use ''UFE\Engine\Scripts\DestroyScript.cs'' instead.


----
====== Related Videos ======
{{youtube>-dmVAf_cyN8?medium}}
{{youtube>j3B-lhd8JBw?medium}}

----
Code access:

''UFE.config.networkOptions''

----

[[global:start|< Back to Global Editor]]
Universal Fighting Engine

User Tools

Site Tools

Page Tools
