Skip to content

Commit

Permalink
feat: added commands page
Browse files Browse the repository at this point in the history
  • Loading branch information
Jooty committed Nov 24, 2023
1 parent 9ed6ae6 commit 3d8484b
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 2 deletions.
43 changes: 43 additions & 0 deletions docs/modules/imlight/commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Commands
A number of commands are available for game masters.

Security tiers:
* `0` - Normal Player
* `1` - Hall Monitors
* `2` - Developers (_only available in debug build_)
* `3` - Game Master

If Imlight was built in _release_ mode, any command with a developer security level required will instead be forwarded to Game Master tier.

::: warning
Commands are not currently available for quality-assurance branch.
:::

## Ungrouped Commands
| Command | Security | Syntax | Description |
| ------- | -------- | ------ | ----------- |
| teleport | Hall Monitor | `.teleport $zonename` | Teleports you to a specific zone. If a zone is not found, it will guess. |

## Account Commands

| Command | Security | Syntax | Description |
| ------- | -------- | ------ | ----------- |
| account | Hall Monitor | `.account` | Shows all the available account commands. |
| account create | Hall Monitor | `.account create $username $password` | Creates an account with a username and password. |
| account delete | Game Master | `.account delete $username` | Deletes an account associated with a username. |
| account lock | Hall Monitor | `.account lock $username` | Prevents an account from logging in. |
| account unlock | Hall Monitor | `.account unlock $username` | Unlocks an account. |
| account password | Game Master | `.account password $username $password $password` | Changes the password for an account. |
| account authlevel | Game Master | `.account authlevel $username $newlevel` | Sets the authority level for an account, |
| account info | Hall Monitor | `.account info $username` | Shows information about an account. |
| account infractions | Hall Monitor | `.account infractions $username` | Shows the infractions set on an account. |
| account warn | Hall Monitor | `.account warn $username $reason` | Adds an infraction record to an account. |
| account removewarn | Hall Monitor | `.account removewarn $username` | Removes an infraction record from an account. |
| ban account | Hall Monitor | `.ban account $username $bantime <e.g. 4d20h3s> $reason` | Bans an account for an amount of time. |
| ban ip | Hall Monitor | `.ban ip $ip $bantime <e.g. 4d20h3s> $reason` | Bans an IP for an amount of time. |
| ban machine | Hall Monitor | `.ban machine $machineid $bantime <e.g. 4d20h3s> $reason` | Bans a machine Id for an amount of time. |
| ban info | Hall Monitor | `.ban info $username` | Shows information about the most recent ban on an account. |
| ban list | Hall Monitor | `.ban list` | Shows a list of currently banned accounts. |
| unban account | Hall Monitor | `.unban account $username` | Unbans an account. |
| unban ip | Hall Monitor | `.unban ip $ip` | Unbans an IP. |
| unban machine | Hall Monitor | `.unban machine $machineid` | Unbans a machine ID. |
5 changes: 3 additions & 2 deletions docs/modules/imlight/contrib/building.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Building Imlight
Hello, developers! Just a reminder that Imlight is still closed-source and only available to the team of Revive101.

## Development Environment
All 3 [parts](../index.md#imlight-parts) are running [dotnet 7.0](https://dotnet.microsoft.com/en-us/download/dotnet/7.0).
Expand All @@ -12,7 +13,7 @@ Imlight has a few running gears, and expects existing tools to be available at s
Imlight sources the same files the game client uses for patching, and a URL to that patch server should be present in `Config/Imlight.ini`. You may run your own patch server using [Aurorium](https://github.com/Revive101/Aurorium).

::: warning
Do not _ever_ point Imlight towards the live patch server.
Do not _ever_ point Imlight towards the live patch server.
:::

#### Dragon Database
Expand All @@ -31,7 +32,7 @@ If a database URL *is* present, _dragon_ requires certificates to be available a
## FAQ
> After selecting a character, the game hangs.
If you're running Imlight on the same machine you're playing on, check client logs to make sure Imlight is _not_ sending your outside IP.
Imlight is most likely giving the game client the wrong IP.

---

Expand Down

0 comments on commit 3d8484b

Please sign in to comment.