Skip to content

Commit e381a62

Browse files
Default-01Default-01
committed
added ark auto wiper docs
1 parent f826668 commit e381a62

File tree

4 files changed

+257
-1
lines changed

4 files changed

+257
-1
lines changed

‎docs/arkautowiper/_category_.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "ARK Auto Wiper",
3+
"position": 5,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Everything you need to know about the ARK Auto Wiper"
7+
}
8+
}

‎docs/arkautowiper/configuration.mdx

+221
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,221 @@
1+
---
2+
sidebar_position: 3
3+
---
4+
5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
7+
8+
# Configuration
9+
10+
Here is some information about the configuration of the app.
11+
12+
## Configuration File
13+
14+
The `config.js` file is located in the same folder as the app executable. This file contains all the configuration options for the app. You can find a list of all the configuration options below.
15+
16+
## Configuration Options
17+
18+
<Tabs>
19+
<TabItem value="general" label="General">
20+
21+
### General Options
22+
23+
| Command | Default | Description |
24+
| ----------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------- |
25+
| `token` | `-` | The token of the bot, you can get this token from the [Discord Developer Portal](https://discord.com/developers/applications) |
26+
| `guildId` | `-` | The ID of the guild where the bot should be activated, more info about this [here](/docs/information) |
27+
| `dbdAccountId` | `-` | Your account ID of your DBD account, more info about this [here](/docs/information#bot-activation) |
28+
| `logChannelId` | `-` | The ID of the channel where the bot should send logs to. |
29+
| `asmProfilesFolderPath` | `-` | The path to the folder where the ASM profiles are located. |
30+
| `debugMode` | `false` | If the app should be in debug mode. |
31+
| `clusters` | `clusters[]` | The ark clusters that should be used by the app, the clusters options are listed below. |
32+
| `mapNamings` | `mapNamings[]` | The map namings that should be used by the app, the namings options are listed below. |
33+
34+
</TabItem>
35+
<TabItem value="clusters" label="Clusters">
36+
37+
### Cluster Options
38+
39+
Below are all options inside the `clusters` list. You can add as many clusters as you want.
40+
41+
| Command | Default | Description |
42+
| -------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------ |
43+
| `identifier` | `-` | The identifier of the cluster, this is used to identify the cluster in the app. |
44+
| `name` | `-` | The name of the cluster, this is used to display the cluster in the app. |
45+
| `discord` | [**discordOptions**](#cluster-discord-options) | The discord options for the cluster, the options are listed below. |
46+
| `vote` | [**voteOptions**](#cluster-vote-options) | The vote options for the cluster, the options are listed below. |
47+
| `reminder` | [**reminderOptions**](#cluster-reminder-options) | The reminder options for the cluster, the options are listed below. |
48+
| `wipe` | [**wipeOptions**](#cluster-wipe-options) | The wipe options for the cluster, the options are listed below. |
49+
| `announcement` | [**announcementOptions**](#cluster-announcement-options) | The announcement options for the cluster, the options are listed below. |
50+
| `servers` | [**serverOptions**](#cluster-server-options) | The servers that should be used by the cluster, the server options are listed below. |
51+
| `steamCMDFolderPath` | `D:\\asmdata\\SteamCMD` | The path to the folder where the steamcmd files are located. |
52+
| `savesFolderPath` | `D:\\asmdata\\Clusters\\test` | The path to the folder where the save files are located. |
53+
| `databases` | [**databasesOptions**](#cluster-database-options) | The database options for the cluster, the options are listed below. |
54+
| `deleteFilePaths` | `[]` | The file paths that should be deleted when the cluster wipes. |
55+
56+
#### Cluster Discord Options
57+
58+
Below are all options inside the `cluster.discord` object.
59+
60+
| Command | Default | Description |
61+
| ------------------- | ------- | ------------------------------------------------------------------------- |
62+
| `removeRolesOnWipe` | `true` | If the bot should remove the roles of the players when the cluster wipes. |
63+
| `removeRoleNames` | `[]` | The names of the roles that should be removed when the cluster wipes. |
64+
65+
#### Cluster Vote Options
66+
67+
Below are all options inside the `cluster.vote` object.
68+
69+
| Command | Default | Description |
70+
| -------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
71+
| `autoStart` | `true` | If the vote should automatically start when the cluster is ready to be wiped |
72+
| `channelId` | `-` | The ID of the channel where the vote should be started in. |
73+
| `mapEmojis` | `['0️⃣', '1️⃣', '2️⃣',...]` | The emojis that should be used for the maps. |
74+
| `mapNames` | `['Ragnarok', 'TheIsland',...]` | The names of the maps that should be used for the vote. |
75+
| `allowMultipleVotes` | `true` | If the players should be allowed to vote multiple times. |
76+
| `startDate` | `0 0 15 1/1 * ? *` | The cron expression for the start date of the vote. (generate interval at [www.cronmaker.com](http://www.cronmaker.com/)) |
77+
| `endDate` | `0 5 15 1/1 * ? *` | The cron expression for the end date of the vote. (generate interval at [www.cronmaker.com](http://www.cronmaker.com/)) |
78+
| `embedTitle` | `-` | The title of the vote embed. |
79+
| `embedDescription` | `-` | The description of the vote embed. |
80+
| `embedColor` | `#038CB5` | The color of the vote embed. |
81+
| `embedImage` | `-` | The image of the vote embed. |
82+
| `embedFooterText` | `-` | The footer text of the vote embed. |
83+
| `embedFooterIcon` | `-` | The footer icon of the vote embed. |
84+
| `embedThumbnail` | `-` | The thumbnail of the vote embed. |
85+
| `embedAuthorName` | `-` | The author name of the vote embed. |
86+
| `embedAuthorIcon` | `-` | The author icon of the vote embed. |
87+
| `embedUrl` | `-` | The url of the vote embed. |
88+
89+
#### Cluster Reminder Options
90+
91+
Below are all options inside the `cluster.reminder` object.
92+
93+
| Command | Default | Description |
94+
| ------------------ | ------------------ | -------------------------------------------------------------------------------------------------------------------- |
95+
| `autoRemind` | `true` | If the reminder should automatically start when the cluster is ready to be wiped |
96+
| `interval` | `0 7 22 1/1 * ? *` | The cron expression for the reminder interval. (generate interval at [www.cronmaker.com](http://www.cronmaker.com/)) |
97+
| `channelId` | `-` | The ID of the channel where the reminder should be sent in. |
98+
| `content` | `-` | The content of the reminder message. |
99+
| `embedTitle` | `-` | The title of the reminder embed. |
100+
| `embedDescription` | `-` | The description of the reminder embed. |
101+
| `embedColor` | `#038CB5` | The color of the reminder embed. |
102+
| `embedImage` | `-` | The image of the reminder embed. |
103+
| `embedFooterText` | `-` | The footer text of the reminder embed. |
104+
| `embedFooterIcon` | `-` | The footer icon of the reminder embed. |
105+
| `embedThumbnail` | `-` | The thumbnail of the reminder embed. |
106+
| `embedAuthorName` | `-` | The author name of the reminder embed. |
107+
| `embedAuthorIcon` | `-` | The author icon of the reminder embed. |
108+
| `embedUrl` | `-` | The url of the reminder embed. |
109+
110+
#### Cluster Wipe Options
111+
112+
Below are all options inside the `cluster.wipe` object.
113+
114+
| Command | Default | Description |
115+
| --------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------ |
116+
| `downtimeStart` | `0 0 22 1/1 * ? *` | The cron expression for the start of the downtime. (generate interval at [www.cronmaker.com](http://www.cronmaker.com/)) |
117+
| `wipeStart` | `0 5 22 1/1 * ? *` | The cron expression for the start of the wipe. (generate interval at [www.cronmaker.com](http://www.cronmaker.com/)) |
118+
| `serverStart` | `0 0 23 1/1 * ? *` | The cron expression for the start of the servers. (generate interval at [www.cronmaker.com](http://www.cronmaker.com/)) |
119+
120+
#### Cluster Announcement Options
121+
122+
Below are all options inside the `cluster.announcement` object.
123+
124+
| Command | Default | Description |
125+
| ------------------ | --------- | ------------------------------------------------------------------------------------ |
126+
| `autoAnnounce` | `true` | If the announcement should automatically start when the cluster is ready to be wiped |
127+
| `channelId` | `-` | The ID of the channel where the announcement should be sent in. |
128+
| `content` | `-` | The content of the announcement message. |
129+
| `embedTitle` | `-` | The title of the announcement embed. |
130+
| `embedDescription` | `-` | The description of the announcement embed. |
131+
| `embedColor` | `#038CB5` | The color of the announcement embed. |
132+
| `embedImage` | `-` | The image of the announcement embed. |
133+
| `embedFooterText` | `-` | The footer text of the announcement embed. |
134+
| `embedFooterIcon` | `-` | The footer icon of the announcement embed. |
135+
| `embedThumbnail` | `-` | The thumbnail of the announcement embed. |
136+
| `embedAuthorName` | `-` | The author name of the announcement embed. |
137+
| `embedAuthorIcon` | `-` | The author icon of the announcement embed. |
138+
| `embedUrl` | `-` | The url of the announcement embed. |
139+
140+
#### Cluster Server Options
141+
142+
Below are all options inside the `cluster.servers` array.
143+
144+
| Command | Default | Description |
145+
| ------------------------- | ------------------------------- | ------------------------------------------ |
146+
| `name` | `-` | The name of the server. |
147+
| `ip` | `-` | The IP of the server. |
148+
| `queryPort` | `-` | The query port of the server. |
149+
| `rconPort` | `-` | The RCON port of the server. |
150+
| `rconPassword` | `-` | The RCON password of the server. |
151+
| `gameUserSettingsIniPath` | `D:\\asmdata\\Servers...` | The path to the GameUserSettings.ini file. |
152+
| `dynamicServerName` | `true` | If the server name should be dynamic. |
153+
| `serverName` | `-` | The server name. |
154+
| `updateServer` | `true` | If the server should be updated. |
155+
| `updateMods` | `true` | If the mods should be updated. |
156+
| `installFolderPath` | `D:\\asmdata\\Servers\\Server1` | The install folder path. |
157+
| `runServerFilePath` | `D:\\asmdata\\Servers...` | The path to the runserver.bat file. |
158+
| `savesFolderPath` | `D:\\asmdata\\Servers...` | The path to the saves folder. |
159+
| `logsFolderPath` | `D:\\asmdata\\Servers...` | The path to the logs folder. |
160+
161+
#### Cluster database Options
162+
163+
Below are all options inside the `cluster.databases` object.
164+
165+
| Command | Default | Description |
166+
| -------------- | -------------------- | ----------------------------- |
167+
| `host` | `-` | The host of the database. |
168+
| `user` | `-` | The user of the database. |
169+
| `password` | `-` | The password of the database. |
170+
| `database` | `wipetest` | The database name. |
171+
| `tablesToDrop` | `['test1', 'test2']` | The tables to drop. |
172+
173+
</TabItem>
174+
<TabItem value="mapNamings" label="Map Namings">
175+
176+
### Map Namings
177+
178+
Below are all options inside the `mapNamings` object.
179+
180+
| Command | Default | Description |
181+
| ------- | ------- | ---------------------------------------- |
182+
| `name` | `-` | The name how you want it to be displayed |
183+
| `mapId` | `-` | The map ID of the ark map |
184+
185+
#### Example
186+
187+
```json
188+
"mapNamings": [
189+
{
190+
"name": "Valguero",
191+
"mapId": "Valguero_P",
192+
},
193+
{
194+
"name": "Genesis2",
195+
"mapId": "Gen2",
196+
},
197+
{
198+
"name": "Aberration",
199+
"mapId": "Aberration_P",
200+
},
201+
{
202+
"name": "ScorchedEarth",
203+
"mapId": "ScorchedEarth_P",
204+
},
205+
{
206+
"name": "Fjördur",
207+
"mapId": "Fjordur",
208+
},
209+
]
210+
```
211+
212+
</TabItem>
213+
</Tabs>
214+
215+
## Cache File
216+
217+
:::warning
218+
Never edit the cache file yourself, this can cause issues with the bot!
219+
:::
220+
221+
The cache file is used to store data, you never have to edit this file yourself. editing this file can cause issues with the bot. If you want to reset the cache file, you can replace the current cache file with the default cache file you get when you download the bot.

‎docs/arkautowiper/information.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Information
6+
7+
Here is some general information about the bot to help you get started.
8+
9+
:::info
10+
The bot is only supported on Windows at the moment, but I am planning on adding support for Linux in the future. Also Pterodactyl support is coming soon!
11+
:::
12+
13+
This bot is used to automate the entire ark server wiping process. It has a ton of features and is very customizable. You can find all the configuration options [**here**](/docs/arkautowiper/configuration).
14+
15+
## File and Folder Paths
16+
17+
In the configuration of the bot you will see multiple options that require a file or folder path. Make sure this path is the full path to the file or folder. For example, if you want to use the `arkmanager.cfg` file in the `C:\arkserver\ShooterGame\Saved\Config\WindowsServer` folder, you would use `C:\arkserver\ShooterGame\Saved\Config\WindowsServer\arkmanager.cfg` as the path.
18+
19+
## What is Cron?
20+
21+
This bot uses cron to schedule tasks. Cron is a time-based job scheduler in Unix-like computer operating systems. Cron is used to schedule jobs (commands or shell scripts) to run periodically at fixed times, dates, or intervals. This allows you to schedule the bot to run actions at specific times.
22+
23+
When you would use timestamps you would need to update the timestamps every time you want to change the time or after every wipe. With cron you can just set it and forget it because it will automatically determine the next wipe time.
24+
25+
## Still need help?
26+
27+
If you still need help with the app, you can join the support server [**here**](https://discord.gg/5xEwm8e6Vy).

‎docusaurus.config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ const config = {
2121
organizationName: 'defaultsbotdevelopment', // Usually your GitHub org/user name.
2222
projectName: 'dbd-docs', // Usually your repo name.
2323

24-
onBrokenLinks: 'throw',
24+
onBrokenLinks: 'warn',
2525
onBrokenMarkdownLinks: 'warn',
2626

2727
// Even if you don't use internalization, you can use this field to set useful

0 commit comments

Comments
 (0)