Difference between revisions of "Hosting"

From Ark Arena Mod
Jump to: navigation, search
(→‎= Required Mods)
(→‎Frequently Asked Questions)
 
(113 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
This page contains all information needed if you wish to host your own Ark Arena server instance.
 
This page contains all information needed if you wish to host your own Ark Arena server instance.
  
−
== Authorization ==
+
<b>Ark Arena is absolutely free to install for anyone who wants to run an Arena server. </b>
−
All servers must be IP whitelisted in order to run the Ark Arena map. If you would like to run the Ark Arena map, contact Metsfan in Discord.
 
−
https://discord.gg/7QTGDXj
 
  
 
== Configuration ==
 
== Configuration ==
 +
=== Environment ===
 +
At this time, Arena is only guaranteed to run correctly on a dedicated server with direct box access. Although it is possible to run in a shared hosting environment, success it not guarenteed.
 +
 +
If you would like to run Arena in a shared hosting environment, our recommendation is [https://pingperfect.com PingPerfect]. This host has been tested and verified to work with Arena. We receive no revenue for this recommendation.
  
 
=== Mod Map ID ===
 
=== Mod Map ID ===
 
  1517538187
 
  1517538187
−
 
−
=== Required Mods ==
 
−
924619115
 
−
1993381275
 
−
849985437
 
  
 
=== Map Name ===
 
=== Map Name ===
 
  ArenaModMap
 
  ArenaModMap
 +
 +
=== Server Launch Arguments ===
 +
-culture=en
  
 
=== GameUserSettings.ini ===
 
=== GameUserSettings.ini ===
−
Add the following to the bottom of your GameUserSettings.ini file
+
Add the following to the bottom of your GameUserSettings.ini file. For most setups, these are the only parameters you should need to set manually.
 
  PreventDownloadSurvivors=true
 
  PreventDownloadSurvivors=true
 
  PreventDownloadItems=true
 
  PreventDownloadItems=true
Line 37: Line 37:
 
  ElementShardsMultiplier=1.0
 
  ElementShardsMultiplier=1.0
 
  LeaderboardName=YOUR COMMUNITY NAME HERE
 
  LeaderboardName=YOUR COMMUNITY NAME HERE
 +
 +
==== Configurations Details ====
 +
All configurations go in the [ArkArena] section of GameUserSettings.ini.
 +
 +
In most circumstances, only the <strong>required</strong> properties should be used.
 +
 +
{| class="wikitable"
 +
|-
 +
! Configuration !! Required !! Type !! Description !! Default Value
 +
|-
 +
| StartingElementShardsQuantity || yes || number || The amount of element shards a player will have the first time they join the server || 0
 +
|-
 +
| ElementShardsMultiplier || yes || number || The rate at which players will earn element shards || 1.0
 +
|-
 +
| LeaderboardName || yes || text || The name of your leaderboard for tracking player stats. Please use a unique name. || ""
 +
|-
 +
| DisableGold || no || true/false || Disables purchases of gold and spending gold in the Collection tab || false
 +
|-
 +
| AFKTimeout || no || number || Set your maximum AFK time in seconds. We recommend 900 (15 minutes). <br> If players are AFK longer than this time they will be removed from the server.<br>Disabled if set to 0 or not used || 0
 +
|-
 +
| ClusterMode || no || number || Useful when running multiple Arena servers in a cluster.<br> <strong>In most circumstances this parameter should not be used</strong> <br>0 = Cluster Mode disabled. <br>1 = Deathmatch game modes only. <br>2 = Capture the Artifact only || 0
 +
|-
 +
| DynamicShardsMultiplier || no || true/false || When enabled, the Element shard multiplier can be changed while the server is active using a cheat command.<br>See [[Hosting#Cheat_Commands|Cheat Commands]] for details || false
 +
|}
  
 
=== Game.ini ===
 
=== Game.ini ===
Line 45: Line 69:
 
  IncreasePvPRespawnIntervalMultiplier=1
 
  IncreasePvPRespawnIntervalMultiplier=1
 
  bIncreasePvPRespawnInterval=false
 
  bIncreasePvPRespawnInterval=false
−
  LimitTurretsNum=7
+
  LimitTurretsNum=5
 
  GlobalSpoilingTimeMultiplier=5.0
 
  GlobalSpoilingTimeMultiplier=5.0
 
  ConfigOverrideItemMaxQuantity=(ItemClassString="PrimalItemConsumable_RawMutton_C",Quantity=(MaxItemQuantity=200, bIgnoreMultiplier=true))
 
  ConfigOverrideItemMaxQuantity=(ItemClassString="PrimalItemConsumable_RawMutton_C",Quantity=(MaxItemQuantity=200, bIgnoreMultiplier=true))
Line 53: Line 77:
 
  GlobalCorpseDecompositionTimeMultiplier=0.1
 
  GlobalCorpseDecompositionTimeMultiplier=0.1
 
  HairGrowthSpeedMultiplier=1000.0
 
  HairGrowthSpeedMultiplier=1000.0
−
  TamedDinoClassResistanceMultipliers=(ClassName="Arena_Boss_HelperMonkey_C", Multiplier=1.0)
+
  OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekBoots_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
−
  TamedDinoClassResistanceMultipliers=(ClassName="Arena_Boss_HelperDragon_C", Multiplier=1.5)
+
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekGloves_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
−
  TamedDinoClassResistanceMultipliers=(ClassName="Arena_Boss_HelperBroodmother_C", Multiplier=1.2)
+
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekHelmet_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
−
  TamedDinoClassResistanceMultipliers=(ClassName="Arena_WyvernFire_C", Multiplier=0.7)
+
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekPants_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
−
  TamedDinoClassResistanceMultipliers=(ClassName="Arena_WyvernLightning_C", Multiplier=0.7)
+
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekShirt_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
−
  TamedDinoClassResistanceMultipliers=(ClassName="Arena_WyvernPoison_C", Multiplier=0.7)
+
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_SpaceDolphin_Saddle_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
−
  PerLevelStatsMultiplier_DinoWild[7]=3.0
+
EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekBoots_C",LevelToAutoUnlock=0)
 +
  EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekGloves_C",LevelToAutoUnlock=0)
 +
  EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekHelmet_C",LevelToAutoUnlock=0)
 +
  EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekPants_C",LevelToAutoUnlock=0)
 +
  EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekShirt_C",LevelToAutoUnlock=0)
 +
  EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_SpaceDolphin_Saddle_C",LevelToAutoUnlock=0)
 +
 
 +
=== Extra Files ===
 +
Extract the following zip file into the directory on your server
 +
  <ArkInstallation>/ShooterGame/Saved/SaveGames/ArkArena/Structures
 +
 
 +
https://drive.google.com/file/d/10FsqdsRwnxGCEA-4u1y-n7j7mb6IlRDD/view?usp=sharing
 +
 
 +
== In-Game Shop ==
 +
=== Additional Items ===
 +
At this time there is no ability to customize the In-Game shop through configuration. If there are additional items you would like to add to the Arena shop, please [[Hosting#Contact|Contact Metsfan in Discord]].
 +
 
 +
If an item is added to the in-game shop it will be available for all Arena servers. At this time we do not support server-specific items.
 +
 
 +
=== Gold ===
 +
Unfortunately Server owners cannot modify the Gold system in any way. All revenue earned from Gold will go to the mod developer unless otherwise discussed with the mod developer.
 +
 
 +
If this is an issue, you can choose to disable Gold through configuration. See the [[Hosting#Configurations_Details|Configuration]] section for details.
 +
 
 +
Gold cannot be given through cheat commands. The only way to receive Gold is by purchasing it in the Arena shop, or through a gift directly from the mod developer.
 +
 
 +
==== Revenue Sharing ====
 +
If you would like to add new cosmetic items to the shop which are your own intellectual property, please [[Hosting#Contact|Contact Metsfan in Discord]] and we can discuss a revenue sharing opportunity.
 +
 
 +
== Cheat Commands ==
 +
 
 +
Server admins will have access to the following custom cheat commands
 +
 
 +
{| class="wikitable"
 +
|-
 +
! Command Syntax !! Description !! Notes !! Example
 +
|-
 +
| cheat scriptcommand addcurrency <steamid> <amount> || Give Element Shards to a specific player || amount should be a number || cheat scriptcommand addcurrency 76561198027275868 10000
 +
|-
 +
| cheat scriptcommand addcurrency <amount> || Give Element Shards to the current player || amount should be a number || cheat scriptcommand addcurrency 10000
 +
|-
 +
| cheat scriptcommand addgamecurrency <steamid> <amount> || Give Hexagons to a specific player in Capture the Artifact || amount should be a number || cheat scriptcommand addgamecurrency 76561198027275868 5000
 +
|-
 +
| cheat scriptcommand addgamecurrency <amount> || Give Hexagons to the current player in Capture the Artifact || amount should be a number || cheat scriptcommand addgamecurrency 5000
 +
|-
 +
| cheat scriptcommand endcta <result> || Prematurely end a Capture the Artifact game || Values for result:<br>0 = Draw<br>1 = Red Team wins<br>2 = Blue Team wins || cheat scriptcommand endcta 0
 +
|-
 +
| cheat scriptcommand setshardrate <rate> || Update the Element Shards multiplier for the current session.<br>This value will be lost if the server is restarted || rate should be at least 1.0. Decimals are allowed<br>Requires DynamicShardsMultiplier=true in the [ArkArena] configuration section.<br>See [[Hosting#Configurations_Details|Configuration]] for details. || cheat scriptcommand setshardrate 1.5
 +
|}
 +
 
 +
== Frequently Asked Questions ==
 +
 
 +
'''How do I reset my leaderboard?'''<br>
 +
To reset your leaderboard:
 +
 
 +
# Go into your GameUserSettings.ini in the [ArkArena] section and change the LeaderboardName property to something new.
 +
# In your ark server installation, delete the following directory
 +
  <ArkInstallation>/ShooterGame/Saved/SaveGames/ArkArena/Ratings
 +
 
 +
'''How do I wipe an individual player's items and shards?'''<br>
 +
In your ark server, visit the following directory, and delete the file <Steam64ID>.sav
 +
  <ArkInstallation>/ShooterGame/Saved/SaveGames/ArkArena
 +
 
 +
'''How do I wipe items and shards for all players?'''<br>
 +
In your ark server, visit the following directory, and delete all files ending in .sav
 +
  <ArkInstallation>/ShooterGame/Saved/SaveGames/ArkArena
 +
 
 +
'''Can I monetize my Arena server?'''<br>
 +
Yes, you may sell whatever products you want on your Arena server, as long as you have the rights to sell whatever you are selling.
 +
 
 +
'''Who gets the revenue from Gold?'''<br>
 +
All revenue earned from Gold will go to the mod developer. Unfortunately this cannot be changed. See [[Hosting#Gold|Gold]] for more details.
 +
 
 +
'''Can I run other mods or plugins on my Arena server?'''<br>
 +
Most mods and plugins should work together with Arena. However Arena does override some base game functionality which can cause certain mods to not work correctly. If you want to run a specific mod which is not working correctly with Arena, please contact Metsfan in discord, however there is no guarantee that the changes will be possible.

Latest revision as of 14:58, 1 May 2022

This page contains all information needed if you wish to host your own Ark Arena server instance.

Ark Arena is absolutely free to install for anyone who wants to run an Arena server.

Configuration

Environment

At this time, Arena is only guaranteed to run correctly on a dedicated server with direct box access. Although it is possible to run in a shared hosting environment, success it not guarenteed.

If you would like to run Arena in a shared hosting environment, our recommendation is PingPerfect. This host has been tested and verified to work with Arena. We receive no revenue for this recommendation.

Mod Map ID

1517538187

Map Name

ArenaModMap

Server Launch Arguments

-culture=en

GameUserSettings.ini

Add the following to the bottom of your GameUserSettings.ini file. For most setups, these are the only parameters you should need to set manually. 

PreventDownloadSurvivors=true
PreventDownloadItems=true
PreventDownloadDinos=true
PreventUploadSurvivors=true
PreventUploadItems=true
PreventUploadDinos=true
XPMultiplier=10.0
StructureResistanceMultiplier=2.0
EnablePvPGamma=true
DifficultyOffset=0.0
PreventTribeAlliances=true
PreventSpawnAnimations=true

[ArkArena]
StartingElementShardsQuantity=10000
ElementShardsMultiplier=1.0
LeaderboardName=YOUR COMMUNITY NAME HERE

Configurations Details

All configurations go in the [ArkArena] section of GameUserSettings.ini.

In most circumstances, only the required properties should be used.

Configuration Required Type Description Default Value
StartingElementShardsQuantity yes number The amount of element shards a player will have the first time they join the server 0
ElementShardsMultiplier yes number The rate at which players will earn element shards 1.0
LeaderboardName yes text The name of your leaderboard for tracking player stats. Please use a unique name. ""
DisableGold no true/false Disables purchases of gold and spending gold in the Collection tab false
AFKTimeout no number Set your maximum AFK time in seconds. We recommend 900 (15 minutes).
If players are AFK longer than this time they will be removed from the server.
Disabled if set to 0 or not used		 0
ClusterMode no number Useful when running multiple Arena servers in a cluster.
In most circumstances this parameter should not be used
0 = Cluster Mode disabled.
1 = Deathmatch game modes only.
2 = Capture the Artifact only		 0
DynamicShardsMultiplier no true/false When enabled, the Element shard multiplier can be changed while the server is active using a cheat command.
See Cheat Commands for details		 false

Game.ini

Add the following to the [/script/shootergame.shootergamemode] section of your Game.ini file 

[/script/shootergame.shootergamemode]
IncreasePvPRespawnIntervalBaseAmount=0
IncreasePvPRespawnIntervalCheckPeriod=30
IncreasePvPRespawnIntervalMultiplier=1
bIncreasePvPRespawnInterval=false
LimitTurretsNum=5
GlobalSpoilingTimeMultiplier=5.0
ConfigOverrideItemMaxQuantity=(ItemClassString="PrimalItemConsumable_RawMutton_C",Quantity=(MaxItemQuantity=200, bIgnoreMultiplier=true))
ConfigOverrideItemMaxQuantity=(ItemClassString="PrimalItemConsumable_RawPrimeMeat_C",Quantity=(MaxItemQuantity=200, bIgnoreMultiplier=true))
bDisableFriendlyFire=true
PoopIntervalMultiplier=1000
GlobalCorpseDecompositionTimeMultiplier=0.1
HairGrowthSpeedMultiplier=1000.0
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekBoots_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekGloves_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekHelmet_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekPants_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_TekShirt_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
OverrideNamedEngramEntries=(EngramClassName="EngramEntry_SpaceDolphin_Saddle_C",EngramLevelRequirement=0,EngramPointsCost=0,EngramHidden=False,RemoveEngramPreReq=True)
EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekBoots_C",LevelToAutoUnlock=0)
EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekGloves_C",LevelToAutoUnlock=0)
EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekHelmet_C",LevelToAutoUnlock=0)
EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekPants_C",LevelToAutoUnlock=0)
EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_TekShirt_C",LevelToAutoUnlock=0)
EngramEntryAutoUnlocks=(EngramClassName="EngramEntry_SpaceDolphin_Saddle_C",LevelToAutoUnlock=0)

Extra Files

Extract the following zip file into the directory on your server 

<ArkInstallation>/ShooterGame/Saved/SaveGames/ArkArena/Structures

https://drive.google.com/file/d/10FsqdsRwnxGCEA-4u1y-n7j7mb6IlRDD/view?usp=sharing

In-Game Shop

Additional Items

At this time there is no ability to customize the In-Game shop through configuration. If there are additional items you would like to add to the Arena shop, please Contact Metsfan in Discord.

If an item is added to the in-game shop it will be available for all Arena servers. At this time we do not support server-specific items.

Gold

Unfortunately Server owners cannot modify the Gold system in any way. All revenue earned from Gold will go to the mod developer unless otherwise discussed with the mod developer.

If this is an issue, you can choose to disable Gold through configuration. See the Configuration section for details.

Gold cannot be given through cheat commands. The only way to receive Gold is by purchasing it in the Arena shop, or through a gift directly from the mod developer.

Revenue Sharing

If you would like to add new cosmetic items to the shop which are your own intellectual property, please Contact Metsfan in Discord and we can discuss a revenue sharing opportunity.

Cheat Commands

Server admins will have access to the following custom cheat commands

Command Syntax Description Notes Example
cheat scriptcommand addcurrency <steamid> <amount> Give Element Shards to a specific player amount should be a number cheat scriptcommand addcurrency 76561198027275868 10000
cheat scriptcommand addcurrency <amount> Give Element Shards to the current player amount should be a number cheat scriptcommand addcurrency 10000
cheat scriptcommand addgamecurrency <steamid> <amount> Give Hexagons to a specific player in Capture the Artifact amount should be a number cheat scriptcommand addgamecurrency 76561198027275868 5000
cheat scriptcommand addgamecurrency <amount> Give Hexagons to the current player in Capture the Artifact amount should be a number cheat scriptcommand addgamecurrency 5000
cheat scriptcommand endcta <result> Prematurely end a Capture the Artifact game Values for result:
0 = Draw
1 = Red Team wins
2 = Blue Team wins		 cheat scriptcommand endcta 0
cheat scriptcommand setshardrate <rate> Update the Element Shards multiplier for the current session.
This value will be lost if the server is restarted		 rate should be at least 1.0. Decimals are allowed
Requires DynamicShardsMultiplier=true in the [ArkArena] configuration section.
See Configuration for details.		 cheat scriptcommand setshardrate 1.5

Frequently Asked Questions

How do I reset my leaderboard?
To reset your leaderboard:

  1. Go into your GameUserSettings.ini in the [ArkArena] section and change the LeaderboardName property to something new.
  2. In your ark server installation, delete the following directory
 <ArkInstallation>/ShooterGame/Saved/SaveGames/ArkArena/Ratings

How do I wipe an individual player's items and shards?
In your ark server, visit the following directory, and delete the file <Steam64ID>.sav 

 <ArkInstallation>/ShooterGame/Saved/SaveGames/ArkArena

How do I wipe items and shards for all players?
In your ark server, visit the following directory, and delete all files ending in .sav 

 <ArkInstallation>/ShooterGame/Saved/SaveGames/ArkArena

Can I monetize my Arena server?
Yes, you may sell whatever products you want on your Arena server, as long as you have the rights to sell whatever you are selling.

Who gets the revenue from Gold?
All revenue earned from Gold will go to the mod developer. Unfortunately this cannot be changed. See Gold for more details.

Can I run other mods or plugins on my Arena server?
Most mods and plugins should work together with Arena. However Arena does override some base game functionality which can cause certain mods to not work correctly. If you want to run a specific mod which is not working correctly with Arena, please contact Metsfan in discord, however there is no guarantee that the changes will be possible.

Retrieved from "https://wiki.arkarenamod.com/index.php?title=Hosting&oldid=407"