Skip to content

Commit

Permalink
Added info about command line arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
KarlOfDuty committed Mar 3, 2024
1 parent dea9b09 commit ab1c0af
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can download the latest release [here](https://github.com/KarlOfDuty/SCPDisc

- [Editing messages and languages](docs/Languages.md)

- [Commands](docs/Commands.md)
- [Usage](docs/Usage.md)

- [Building SCPDiscord](docs/Building.md)

Expand Down Expand Up @@ -38,7 +38,7 @@ You can use server and remote admin commands via the bot, with command permissio
### Extra commands
The bot also comes with a few extra commands such as playerinfo, improved ban/unban, and improved mute/unmute commands which all also work on offline players.

More information about bot commands are available [here](docs/Commands.md).
More information about bot commands are available [here](docs/Usage.md).

![helpcommand.png](docs%2Fimg%2Fhelpcommand.png)

Expand Down
2 changes: 1 addition & 1 deletion SCPDiscordBot/Commands/HelpCommand.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public async Task OnExecute(InteractionContext command)
.AddField("Connected:", NetworkSystem.IsConnected() ? "Yes" : "No", true)
.AddField("\u200b", "\u200b", true)
.AddField("Report bugs:", "[Github Issues](https://github.com/KarlofDuty/SCPDiscord/issues)", true)
.AddField("Commands:", "[Github Repository](https://github.com/KarlOfDuty/SCPDiscord/blob/master/docs/Commands.md)", true)
.AddField("Commands:", "[Github Repository](https://github.com/KarlOfDuty/SCPDiscord/blob/master/docs/Usage.md)", true)
.AddField("Donate:", "[Github Sponsors](https://github.com/sponsors/KarlOfDuty)", true);
await command.CreateResponseAsync(botInfo);
}
Expand Down
10 changes: 9 additions & 1 deletion docs/Commands.md → docs/Usage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Bot commands
# Usage

## Bot command line arguments

| Argument | Description |
|--------------------------|-----------------------------------------------------------------------------------|
| `--help` | Shows information about all arguments. |
| `--config <config file>` | Select a specific config file to load. |
| `--leave <server id>` | Make the bot leave one or more Discord servers. The IDs are shown on bot startup. |

## Bot commands

Expand Down

0 comments on commit ab1c0af

Please sign in to comment.