You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data-sources/route_shaders.md
+1-7Lines changed: 1 addition & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,22 +26,16 @@ Required:
26
26
27
27
-`ab_test` (Boolean) If true then AB test mode is enabled. 50%% of users will be eligible for acceleration, and 50%% will not be eligible for acceleration. In the accelerated group, players are only accelerated if the remaining route shader parameters determine they should be accelerated.
28
28
-`acceptable_latency` (Number) The amount of latency that is acceptable in milliseconds. Any latency above this is eligible for acceleration. For example, setting this value to 50ms would exclude any players with latency < 50ms from being accelerated. Default is 20ms
29
-
-`acceptable_packet_loss_instant` (Number) The instantaneous packet loss that is acceptable. For example, setting to 1%% will allow packet loss up to 1%% in a 10 second period before enabling acceleration. Default is 0.25%%
30
-
-`acceptable_packet_loss_sustained` (Number) The sustained packet loss that is acceptable. For example, setting to 0.1%% will allow packet loss up to 0.1%% in a 30 second period before enabling acceleration. Default is 0.1%%
31
-
-`analysis_only` (Boolean) Set this to true and acceleration is disabled. Analytics data will still be gathered from players of any buyer who use this route shader. Use this when you want to gather network perforance data for players, but you want accelerated turned off. Default is false.
29
+
-`acceptable_packet_loss` (Number) The instantaneous packet loss that is acceptable. For example, setting to 1%% will allow packet loss up to 1%% in a 10 second period before enabling acceleration. Default is 0.25%%
32
30
-`bandwidth_envelope_down_kbps` (Number) The maximum amount of acceleration bandwidth down in the server to client direction in kilobits per-second (kbps). Exceeding this amount of bandwidth for a session will result in packets above the limit not being accelerated. Default value is 1024 (1mbps).
33
31
-`bandwidth_envelope_up_kbps` (Number) The maximum amount of acceleration bandwidth up in the client to server direction in kilobits per-second (kbps). Exceeding this amount of bandwidth for a session will result in packets above the limit not being accelerated. Default value is 1024 (1mbps).
34
32
-`disable_network_next` (Boolean) Set this to true and network next is completely disabled for players belonging to any buyer using this route shader. No acceleration will be applied and no data will be collected.
35
33
-`force_next` (Boolean) Force all players to be accelerated. This is useful for testing, or if you have a small professional player base for whom you want to enable acceleration BEFORE anything goes wrong, instead of being reactive and only accelerating them after something goes wrong. Default is false.
36
34
-`latency_reduction_threshold` (Number) The minimum latency reduction threshold in milliseconds. A latency reduction greater than or equal to this number in milliseconds must be predicted in order to accelerate the player. For example, 10ms would only accelerate players if a latency reduction >= 10ms is predicted. Default is 10ms.
37
35
-`max_latency_trade_off` (Number) The maximum amount of latency to trade for reduced packet loss. Packet loss above a certain amount is generally considered worse than latency. Trade up to this amount of latency to take a route with reduced packet loss. IMPORTANT: Network Next will still prefer the lowest latency route available. Default value is 20ms.
38
-
-`max_next_rtt` (Number) The maximum network next latency allowed. There is no point patting yourself on the back when you reduce 500ms latency to 450ms. 450ms is still completely unplayable! Set this value to the maximum reasonable accelerated latency that makes sense for your game. Network Next will not accelerate a player if their predicted post-acceleration latency is higher than this value. Default value is 250ms.
39
-
-`multipath` (Boolean) If this is set to true then packets will be sent across the direct route (default internet path), as well as the network next path when a player is accelerated. Recommend setting this to true always. Default value is true.
40
36
-`name` (String) The name of the route shader. Generally, it's best to set it to the same name as the buyer that will use it. Typically, there is one route shader per-buyer.
41
-
-`route_diversity` (Number) The minimum amount of distinct viable routes that must be available for a player to be accelerated. This setting can be useful to limit players in remote regions from taking network next when there is only one relay available to them. Only players with mulitple distinct paths will be accelerated, so there are backups if one relay becomse unroutable for this player. Don't set this too high or players with bad edge network conditions won't get accelerated. Default value is 0.
42
37
-`route_select_threshold` (Number) When initially selecting a route, find routes within this amount of milliseconds of the best available route and consider them to be equal, randomly selecting between them. Don't set this too low, or you won't get effective load balancing across relays. Default value is 5ms.
43
38
-`route_switch_threshold` (Number) If a player is already being accelerated, and a better route is available with a reduction of at least this much milliseconds from the current route, then switch to it. Don't set this too low or sessions will switch routes every 10 seconds due to natural fluctuation. Default value is 10ms.
44
-
-`rtt_veto` (Number) If the accelerated latency becomes worse than the direct latency (default internet route) by this amount of milliseconds, then veto the session and stop accelerating the player. This is to avoid players hopping on/off of network next when latency fluctuation occurs. Don't set this too low, or players with fluctuating latency (due to edge issues or wifi) will fall off network next due to temporary high latency conditions. Default value is 20ms.
45
39
-`selection_percent` (Number) The percentage of players eligible for acceleration. For example, setting this to 10%% would only accelerate 1 in 10 players. Default value is 100%% (all players eligible for acceleration).
Description: "The instantaneous packet loss that is acceptable. For example, setting to 1%% will allow packet loss up to 1%% in a 10 second period before enabling acceleration. Default is 0.25%%",
Description: "The packet loss that is acceptable. For example, setting to 1%% will allow packet loss up to 1%% before enabling acceleration. Default is 0.25%%",
Description: "The sustained packet loss that is acceptable. For example, setting to 0.1%% will allow packet loss up to 0.1%% in a 30 second period before enabling acceleration. Default is 0.1%%",
904
-
Optional: true,
905
-
Computed: true,
906
-
Default: float64default.StaticFloat64(0.1),
907
-
},
908
-
"analysis_only": schema.BoolAttribute{
909
-
Description: "Set this to true and acceleration is disabled. Analytics data will still be gathered from players of any buyer who use this route shader. Use this when you want to gather network perforance data for players, but you want accelerated turned off. Default is false.",
Description: "The maximum amount of acceleration bandwidth up in the client to server direction in kilobits per-second (kbps). Exceeding this amount of bandwidth for a session will result in packets above the limit not being accelerated. Default value is 1024 (1mbps).",
Description: "If this is set to true then packets will be sent across the direct route (default internet path), as well as the network next path when a player is accelerated. Recommend setting this to true always. Default value is true.",
940
-
Optional: true,
941
-
Computed: true,
942
-
Default: booldefault.StaticBool(true),
943
-
},
944
902
"selection_percent": schema.Float64Attribute{
945
903
Description: "The percentage of players eligible for acceleration. For example, setting this to 10%% would only accelerate 1 in 10 players. Default value is 100%% (all players eligible for acceleration).",
Description: "The maximum network next latency allowed. There is no point patting yourself on the back when you reduce 500ms latency to 450ms. 450ms is still completely unplayable! Set this value to the maximum reasonable accelerated latency that makes sense for your game. Network Next will not accelerate a player if their predicted post-acceleration latency is higher than this value. Default value is 250ms.",
958
-
Optional: true,
959
-
Computed: true,
960
-
Default: int64default.StaticInt64(250),
961
-
},
962
914
"route_switch_threshold": schema.Int64Attribute{
963
915
Description: "If a player is already being accelerated, and a better route is available with a reduction of at least this much milliseconds from the current route, then switch to it. Don't set this too low or sessions will switch routes every 10 seconds due to natural fluctuation. Default value is 10ms.",
Description: "If the accelerated latency becomes worse than the direct latency (default internet route) by this amount of milliseconds, then veto the session and stop accelerating the player. This is to avoid players hopping on/off of network next when latency fluctuation occurs. Don't set this too low, or players with fluctuating latency (due to edge issues or wifi) will fall off network next due to temporary high latency conditions. Default value is 20ms.",
976
-
Optional: true,
977
-
Computed: true,
978
-
Default: int64default.StaticInt64(20),
979
-
},
980
926
"force_next": schema.BoolAttribute{
981
927
Description: "Force all players to be accelerated. This is useful for testing, or if you have a small professional player base for whom you want to enable acceleration BEFORE anything goes wrong, instead of being reactive and only accelerating them after something goes wrong. Default is false.",
982
928
Optional: true,
983
929
Computed: true,
984
930
Default: booldefault.StaticBool(false),
985
931
},
986
-
"route_diversity": schema.Int64Attribute{
987
-
Description: "The minimum amount of distinct viable routes that must be available for a player to be accelerated. This setting can be useful to limit players in remote regions from taking network next when there is only one relay available to them. Only players with mulitple distinct paths will be accelerated, so there are backups if one relay becomse unroutable for this player. Don't set this too high or players with bad edge network conditions won't get accelerated. Default value is 0.",
0 commit comments