xT0Zpcx5

1```sections to list on the right side of the wiki page```
2
3About
4
5Setup Process
6
7Support Process
8
9Feature Request Process
10
11Known Issues
12
13Frequently Asked Questions
14
15Want to help develop Arkbot?
16
17
18
19
20
21
22
23
24
25
26
27
28
29About
30
31What is Arkbot?
32
33In a nutshell:
34- Arkbot is a program that reads map, tribe, player, and cluster files.  It takes that information and displays it in a webpage for admins and players to utilize.  It has an integrated Discord bot to allow running Ark RCON commands and custom RCON commands from within Discord to your servers.
35
36Lengthy explanation:
37- Depending on how the update interval is configured (when a saveworld happens or on a set time interval) Arkbot will read all .ark .arktribe .arkprofile and all cluster directory files.  It will then extract all the structure, creature, player, and tribe information into ram.  That information will then be available for viewing in various web pages on its built in web server.  Players can utilize the information as a way to find missing creatures, check food levels, stats, breeding timers, tribe logs, generator fuel, baby growth, mating time left, and base and current creature levels.  The best part is you do not even have to be in game.  The web interface is accessible via your internet connected tablet, phone, or computer.  Admins can see everything players can see plus additional information like wild creature info, total and tribe structure count, map layouts of where tribes have built, and can manage their servers accordingly with this information.
38
39Key features of Arkbot:
40- Permission based roles for allowing access to different pages of the web interface.
41- Steam authentication for allowing tribe information to be seen by tribe members only.
42- Admin related functions like being able to see all tamed and wild creatures and structures on a map.
43- 3rd party plugin integration to allow admins to destroy structures and creatures from the web interface.
44- Show all online players as of the last map update.
45- Can be ran local on the system you host your maps on or can be ran from a remote system that has access to the save files.
46- Can display information from all maps within your cluster.
47- Discord bot integration for pushing RCON commands to a server (e.g. restarting a map, kicking a player, destroying spoiled wyvern eggs).
48- Notifications of when babys are hatched or born or when a creature is ready to be cuddled
49- Demo site for seeing how the information looks.
50
51Features Arkbot cannot/does not have nor support:
52- Displaying any real time information.
53- Displaying information on items inside containers.
54- Work on official servers.
55- Cannot work on unofficial servers in which the program cannot get access to the .ark .arktribe .arkprofile or cluster save directory files.
56
57
58
59
60
61
62
63
64
65
66
67First Time Setup Process:
68
69Arkbot has been tested on the following operating systems:
70- Windows 10
71- Windows Server 2012 R2
72- Windows Server 2016
73- Windows Server 2019
74- Other operating systems will not be supported by Arkbot staff
75
76
77Required software on the system that will run the Arkbot.exe file:
78- .NET Framework 3.5 SP1 Web Installer	https://dotnet.microsoft.com/download/dotnet-framework/net35-sp1	http://download.microsoft.com/download/2/0/E/20E90413-712F-438C-988E-FDAA79A8AC3D/dotnetfx35.exe
79- .NET Framework 4.7.2 Web Installer	https://dotnet.microsoft.com/download/dotnet-framework/net472		http://go.microsoft.com/fwlink/?LinkId=863262
80- .NET Framework 4.8 Web Installer		https://dotnet.microsoft.com/download/dotnet-framework/net48		http://go.microsoft.com/fwlink/?LinkId=2085155
81- Visual C++ Redistributable Packages for Visual Studio 2013	https://www.microsoft.com/en-us/download/details.aspx?id=40784	https://download.microsoft.com/download/2/E/6/2E61CFA4-993B-4DD4-91DA-3737CD5CD6E3/vcredist_x64.exe
82
83Required port forwarding:
84- Decide on a port number to utilize so users outside your servers local area network can access your Arkbot page.
85- You can choose to utilize the default ports of 60001 for the Web API and 60000 for the Web APP if it does not conflict with any other webserver software on the same system.  Other wise pick two other ports to use.
86- Once you decide on the ports you must figure out how to forward that port to that system.  A good place to get information about that is www.portforward.com or www.google.com.  The Arkbot discord is not the place to ask the Arkbot staff for this kind of support.
87- Be sure to forward both TCP and UDP.
88
89Windows Firewall Management:
90- You will need to setup "inbound rules" in your windows firewall to either allow the arkbot.exe program through or allow the ports you designated through.  If you decide to allow ports instead of the program .exe ensure you enter both the Web API and the Web APP ports.  Also make sure to allow both TCP and UDP for both ports.
91
92Downloading Arkbot:
93- You can download the latest release of Arkbot from https://github.com/ark-mod/ArkBot/releases.  Once you download the compressed file of Arkbot extract it to the location you want to run it from.
94- Your folder structure in the root folder of Arkbot should have a few files and folders in it.  One of those files should be Arkbot.exe.
95
96Configuring Arkbot:
97- At this point and for your sanity's sake you should right click on your Arkbot.exe file and go to properties.  Click on the "Compatibility" tab.  Check the "Run this program as an administrator" box.  Click "OK".  This will force Arkbot to run as admin everything which is a requirement for it to work properly.
98- Double click on Arkbot.exe.  You will notice that several other files and folders have been created.
99- On the Arkbot window go to the "Configuration" tab.
100
101Going through the various Arkbot Options:
102- Under the "Required" section
103	- Steam API Key; enter your Steam API Key.  Dont have one? Get one here https://steamcommunity.com/dev/apikey
104	- Servers; Click the drop down to the far right of the Servers block.  Start adding all our maps you want to include and add all the technical data along with them.  Keep note of the cluster name you provide.  Once done click OK in the bottom right of the window.
105	- Clusters; Click the drop down to the far right of the Clusters block.  Add the cluster name you used for your map in the previous window.  Provide the path you have setup for the cluster files to be stored in.  Once done click OK in the bottom right of the window.
106- Under the Optional section
107	- Bot Name; If you plan to use the integrated Discord bot fill in a name you want your bot to display as in your Discord server.
108	- Bot URL; no idea how this is used.
109	- Web App URL; no idea how this is used.
110	- Under the Web App subsection
111		- Default Theme; choose the default theme users will initially use on the web interface till they set their own custom theme.
112		- Top Menu; by default the navigation menu will default to the left side of the web page.  check this box if you want to default it to the top of the page instead.
113		- Tribe Log Limit; enter the amount of tribe log entries you want tribes to be able to see.
114		- Tribe Log Colors; checking the box will color code the entries based on the type of entry it is.
115		- Custom Style Sheet Path; for use by advanced admins that want to customize themes and page layouts.
116	- Under the Discord subsection
117		- Access Control; customize groups as necessary to give out permissions to various commands.
118		- Announcement Channel; specify a channel used for bot announcements.
119		- Disable Developer Fetch Save Data; stops users added to the developer group from fetching save file data or json file data.
120		- Discord Bot Enabled; check if you want to use the Discord bot feature.
121		- Enabled Channels; a list of channel names where the Discord bot will listen for commands.
122		- Info Topic Channel; add a channel name to where the help and server update info will display.
123		- Member Role Name; this is the role to which the bot will look for to accept commands from.
124		- Steam Open ID Redirect URL; 
125		- Steam Open ID Relying Server Listen Prefix; 
126	- ARK Multipliers subsection
127		- Baby Mature Speed Multiplier; add this info to help calculate info on baby growth.
128		- Cuddle Interval Multiplier; add this info to help calculate info and notifications when babies need cuddling.
129		- Egg Hatch Speed Multiplier; add this info to help calculate info and notifications on your egg being ready to hatch.
130	- User Roles; Click the drop down to the far right of the User Roles block.  add roles to user steam id's.
131	- Access Control subsection
132		- change permission access to roles and which pages they are allowed to access.
133	- Backups subsection
134		- Backups Enabled; check the box to allow Arkbot to backup your map file, tribe files, player files, and cluster files into a zip file.
135		- Backups Directory Path; enter a path you want the zip files saved to.
136	- Web App Redirect Listen Profix(es); enter url's that you want redirected to your web app url.
137	- Powershell Executable Path; leave as is unless your Powershell path is custom.
138	- SSL subsection
139		- Challenge Listen Prefix;
140		- Domain Name(s)
141		- Email
142		- Enabled
143		- Name
144		- Password
145		- Ports
146		- Use compatibility non-SNI Bindings
147	- Web API Listen Prefix; The port the API uses.
148	- Web APP Listen Prefix; The port the web server uses for displaying the webpage.
149	- Temporary Files Directory; The folder you want Arkbot to use for temporary file usage.
150	- Hide UI on Startup; check the box if you want Arkbot to minimize to the taskbar tray once it is executed.
151- Under the Advanced Section
152	Savegame Extraction Max Degree of Parallelism; userd to mark the maximuze amount of worldsave reads you want to execute at any given time.
153	Use Compatibility Change Watcher; checking this box will have Arkbot read all pertinant files ONLY when there is a worldsave conducted and the modified timestamp on the .ark file has changed.
154- Under the Debug section
155	- Discord Log Level; select the degree of logging you want for the Discord boy.
156	- Anonymize Web API Data; check this box if you plan to utilize data dumps for demo purposes.
157
158Saving your Arkbot configuration:
159- Once you have all settings confiured click on the Save button near the top left corner of the Arkbot main window. Close Arkbot.
160
161Using Arkbot for the first time:
162- Before Arkbot will display any information you must have worldsave data at the directories you specified above.  So make sure to run your maps one time and save them one time before you run Arkbot.
163- Run the Arkbot.exe program
164- You should see the main window open.  If you opted to have it minimize by default find the icon in the taskbar tray and double click it.
165- On the main window you should see the console tab is selected and text mentioning "Update queued manually" for all your maps
166- After a few moments you should see text mentioning "Update finished" for all your maps
167- At this point you can open your web browser and type in the WAN IP address of the system you have Arkbot being ran on.  You will want your WAN IP to test if others can connect to your Arkbot page.  One way to get this is www.wanip.info. You may need to include your Web APP port after your WAN IP.  if your WAN IP is 10.20.30.200 and your Web APP port is 60000 you will want to enter http://10.20.30.200:60000 in your web browser if you are not using SSL and https://10.20.30.200:60000 if you are.
168- If you want to just test if the web server is working you can enter use your loopback IP.  Enter 127.0.0.1 in place of where you would have put your WAN IP so http://127.0.0.1:60000
169- If the webserver is working properly you will be brought to your main Arkbot page.
170
171
172Updating to new versions of Arkbot:
173
174- this process will depend on the changes made between version update and which method you decide to proceed with.
175- a general rule of thumb is to follow the steps above for the first time setup process by using a new folder for Arkbot and creating everything from scratch.  An example of this is if your current Arkbot folder is named after a previous version like Arkbot 1.91, you would make a new folder with the updated version of something like Arkbot 1.92.  All the new versions files will go in that folder.
176- A more knowledgeable administrator might choose another method which would be to do whats listed above but also utilize certain existing files to expedite the process.  Keep in mind certain files like config.json can have new formatting changes that might cause undesirable outcomes.  This method is not recommended.
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198Support Process
199
200All Arkbot support is offered solely through the Arkbot Discord server https://discord.gg/Np23aw7.  The Github "Issues" https://github.com/ark-mod/ArkBot/issues?q=is%3Aopen tab will be used for the Arkbot staff and users to track issues, requests, and development.  Arkbot staff will post new topics to the Github "Issues" tab https://github.com/ark-mod/ArkBot/issues?q=is%3Aopen.
201
202
203When requesting support please follow the steps below:
204Step 1. Go to https://github.com/ark-mod/ArkBot/issues?q=is%3Aopen+is%3Aissue+label%3Abug. See if your issue is currently listed and if any workarounds or fixes are provided.								the "Issues" https://github.com/ark-mod/ArkBot/issues?q=is%3Aopen tab in Github, click on the "Label" drop down option and select the option called "bug".  
205Step 2. Join the Arkbot Discord server https://discord.gg/Np23aw7.  Go to the "start-here" channel.  Click the Arkbot reaction icon of the post by Nero.  New channels will appear for you.
206Step 3. Look through the "faq" and "known-issues" channel.  Again see if your issue is listed and if any workarounds or fixes are provided.
207Step 4. Go to the general-user-chat channel and ask your question.
208Step 5. If your issue is something warranty a bug fix you will be asked to create a ticket.
209Step 6. Go to the ticket-request channel. Click on the SOS reaction icon to open a ticket.
210
211
212
213
214
215
216
217Feature Request Process
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233Known Issues
234
235
236
237
238
239
240
241
242
243
244
245
246Frequently Asked Questions
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263Want to help develop Arkbot