Skip to content
This repository has been archived by the owner on Aug 10, 2024. It is now read-only.

Commit

Permalink
Add commands in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Erlite committed Sep 19, 2022
1 parent 9db63a1 commit e080c60
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

## This mod is still in development, do not add it to your server yet as it does not contain a valid database, and might be unstable.

# Spyglass

<a href="https://discord.com/invite/whKMsPN3nu" target="_blank">
Expand Down Expand Up @@ -39,6 +36,22 @@ Using the default settings, a singular `Cheating` infraction will land you an au

Infractions are cumulative, and may lead to greater sanctions (multiple spamming offences will eventually lead to a permanent mute).

## Commands

By default, commands are admin only, and are prefixed by "!".

*Example: !infractions ErliteDev*

```ini
[find]
Example = "!find ErliteDev, !find 1005829030626"
Description = "Attempts to find a user with the given name, or UID. Partial matches work."

[infractions]
Example = "!infractions ErliteDev, !infractions 1005829030626"
Description = "Searches for a player's infractions and displays them in chat."
```

## Configuration Variables

Spyglass is only configured through convars, meaning you can add them to your server's configuration files.
Expand Down

0 comments on commit e080c60

Please sign in to comment.