docs: mkdocs (#163)

* obsidian: start

* e

* ci: workflow_dispatch

* ci: temp

* ci: mkdocs.yml

* ci: test

* ci:test

* ci:test

* obsidian: first commands

* mprove

* ci: test

* test

* ci:test

* ci:test

* ci:test

* ci:test

* ci:test

* ci:test

* ci:test

* ci:test

* ci:test

* chore: test:wq

* docs: change folder structurte

* docs: change docs name

* docs: register channel

* fix: docs path

* docs: unregister chat

* docs: more docs

* docs: auto reply

* docs: event log is md

* docs: more info

* docs: exclude

* srsly

* docs: mkdcos dir

* docs: remove exclude

* docs: quickstart skeleton

* docs: doc link

* docs: quickstart

* chore: build and test

* chore: remove untitles

* chore: rename

---------

Co-authored-by: Damian Laczak <[email protected]>

.github/workflows/obsidian.yml → .github/workflows/mkdocs.yml

@@ -1,9 +1,8 @@
-name: ci
+name: mkdocs
 on:
   push:
     branches:
       - master
-      - docs/obsidian
   workflow_dispatch:
 
 permissions:
@@ -21,7 +20,6 @@ jobs:
           key: ${{ github.ref }}
           path: .cache
       - run: |
-          cd obsidian
           pip install mkdocs-material
           pip install mkdocs-roamlinks-plugin
           pip install mkdocs-rss-plugin

.github/workflows/test.yml

@@ -4,6 +4,7 @@ on: [push]
 
 jobs:
   build:
+    name: Build and test
 
     runs-on: ubuntu-latest
     strategy:

Readme.md

@@ -9,7 +9,7 @@ Provides ability to integrate Discord with your OpenTTD servers.
 
 ## Documentation
 
-https://shoter.github.io/OpenttdDiscord/
+[Documentation link](https://shoter.github.io/OpenttdDiscord/)
 
 ## Functionalities
 

docs/mkdocs/Commands/Auto Replies/Get Auto Replies.md

@@ -0,0 +1,14 @@
+# Get Auto Replies
+
+## Syntax
+
+`/get-auto-replies`
+
+
+## Privilege required
+
+- Moderator
+
+## Description
+
+Lists all auto replies commands in this guild.

docs/mkdocs/Commands/Auto Replies/Get Content.md

@@ -0,0 +1,18 @@
+# Get Auto Reply Content
+
+## Syntax
+
+`/get-auto-reply-content server-name:{name} trigger-message:{trigger}`
+
+## Privilege required
+
+- Moderator
+
+## Requirements
+
+- [[Register Server]]
+- [[Set Auto Reply]]
+
+## Description
+
+Gets message that is going to be displayed after player on server `{name}` writes a message `{trigger}`.

docs/mkdocs/Commands/Auto Replies/Remove Auto Reply.md

@@ -0,0 +1,19 @@
+# Remove Auto Reply Command
+
+## Syntax
+
+`/remove-auto-reply server-name:{name} trigger-message:{trigger}`
+
+
+## Privilege required
+
+- Admin
+
+## Requirements
+
+- [[Register Server]]
+- [[Set Auto Reply]]
+
+## Description
+
+Removes auto reply from given server.

docs/mkdocs/Commands/Auto Replies/Set Auto Reply.md

@@ -0,0 +1,23 @@
+# Set Auto Reply Command
+
+## Syntax
+
+`/set-auto-reply server-name:{name} trigger-message:{trigger} action:{action}`
+
+
+## Privilege required
+
+- Admin
+
+## Requirements
+
+- [[Register Server]]
+
+## Description
+
+Sets auto reply content for given server.
+
+
+### Reset Company action
+
+You can set action to `ResetCompany`. After executing such auto-reply player's company is going to be deleted. It works only when player is the only one in the company.

docs/mkdocs/Commands/Auto Replies/Set Welcome Message.md

@@ -0,0 +1,20 @@
+# Set Welcome Message
+
+## Syntax
+
+`/set-welcome-message server-name:{name}`
+
+
+## Privilege required
+
+- Admin
+
+## Requirements
+
+- [[Register Server]]
+
+## Description
+
+Sets welcome message that is going to be displayed when player enters the server.  
+Message content is going to be set in modal which is going to be displayed after command is executed.  
+Message sent to player is sent as private one - other players are not going to see it.

docs/mkdocs/Commands/Chat integration/Register Chat.md

@@ -0,0 +1,19 @@
+# Register Chat Channel
+
+## Syntax
+
+`/register-chat-channel server-name:{name}`
+
+## Privilege required
+
+- Admin
+
+## Requirements
+
+- [[Register Server]]
+
+## Description
+
+Given discord channel is registered as one that can communicate with given ottd server.  
+All discord messages from this channel are going to land on specified ottd server.  
+All non-private messages from ottd server are going to appear within channel.

docs/mkdocs/Commands/Chat integration/Unregister Chat.md

@@ -0,0 +1,18 @@
+# Unregister Chat Channel
+
+## Syntax
+
+`/unregister-chat-channel server-name:{name}`
+
+## Privilege required
+
+- Admin
+
+## Requirements
+
+- [[Register Server]]
+- [[Register Chat]]
+
+## Description
+
+Removes given server chat integration from channel where command is executed.

docs/mkdocs/Commands/Info/Query Debug Info.md

@@ -0,0 +1,25 @@
+# Query debug info
+
+## Syntax
+
+`/query-debug-info server-name:{name}`
+
+## Privilege required
+
+- Moderator
+
+## Requirements
+
+- [[Register Server]]
+
+## Description
+
+Used mostly for debugging during programming bot. However as server admin you can find interesting things here.  
+
+This command returns a lot of data about server including:
+- Server Name
+- Map size
+- Current date
+- List of players
+- List of companies
+- List of players that were connected in the past

docs/mkdocs/Commands/Info/Query Event Log.md

@@ -0,0 +1,21 @@
+# Query debug info
+
+## Syntax
+
+`/query-event-log server-name:{name}`
+
+## Privilege required
+
+- Moderator
+
+## Requirements
+
+- [[Register Server]]
+
+## Description
+
+Generates a downloadable file with a lot containing all events that happened on the given server. All events have timestamp to make it easy to know what happened at given hour.
+
+## Tip
+
+It is a perfect tool to locate an IP of griefing player who disconnected just before admin connected to the server.

docs/mkdocs/Commands/Info/Query Server.md

@@ -0,0 +1,17 @@
+# Query Server
+
+## Syntax
+
+`/query-server server-name:{name}`
+
+## Privilege required
+
+- Moderator
+
+## Requirements
+
+- [[Register Server]]
+
+## Description
+
+Provides the same info as [[Register Status Monitor]]. Does not update message after it was posted to the given channel.

docs/mkdocs/Commands/Maintenance/Health Check.md

@@ -0,0 +1,14 @@
+# Health Check
+
+## Syntax
+
+`/health-check`
+
+## Privilege required
+
+- Moderator
+
+
+## Description
+
+Checks time to reach database and all registered servers.

docs/mkdocs/Commands/Rcon/List Rcon Channels.md

@@ -0,0 +1,13 @@
+# List Rcon Channels
+
+## Syntax
+
+`/list-rcon-channels`
+
+## Privilege required
+
+- Moderator
+
+## Description
+
+Provides a list of all rcon channels in given discord guild.

docs/mkdocs/Commands/Rcon/Register Rcon Channel.md

@@ -0,0 +1,21 @@
+# Register Rcon Channel
+
+## Syntax
+
+`/register-rcon-channel server-name:{name} prefix:{prefix}`
+
+## Privilege required
+
+- Admin
+
+
+## Description
+
+Registers channel on which command was executed as rcon channel for given server.  
+After registration all messages prefixed with {prefix} are going to be executed as rcon commands on the server.
+
+## Example
+
+Example of rcon channel which has `!` as {prefix}
+
+![Rcon channel example](image.png)

docs/mkdocs/Commands/Rcon/Unregister Rcon Channel.md

@@ -0,0 +1,13 @@
+# Unregister Rcon Channel
+
+## Syntax
+
+`/unregister-rcon-channel server-name:{name}`
+
+## Privilege required
+
+- Admin
+
+## Description
+
+Removes rcon functionality from channel on which this command was executed.

docs/mkdocs/Commands/Reporting/List Report Channels.md

@@ -0,0 +1,13 @@
+# List Report Channels
+
+## Syntax
+
+`/list-report-channels`
+
+## Privilege required
+
+- Moderator
+
+## Description
+
+Provides a list of all reports channels in given discord guild.

docs/mkdocs/Commands/Reporting/Register Report Channel.md

@@ -0,0 +1,15 @@
+# Register Report Channel
+
+## Syntax
+
+`/register-report-channel server-name:{name}`
+
+## Privilege required
+
+- Admin
+
+
+## Description
+
+Registers channel on which report functioanlity is going to be provided.
+After registration all messages on specified ottd server prefixed with `!report` are going to be reported on this channel along with event-log and player list.

docs/mkdocs/Commands/Reporting/Unregister Report Channel.md

@@ -0,0 +1,13 @@
+# Unregister Report Channel
+
+## Syntax
+
+`/unregister-report-channel server-name:{name}`
+
+## Privilege required
+
+- Admin
+
+## Description
+
+Removes report functionality from channel on which this command was executed.

docs/mkdocs/Commands/Roles/Delete Role.md

@@ -0,0 +1,13 @@
+# Delete Role
+
+## Syntax
+
+`/delete-role role:{role}`
+
+## Privilege required
+
+- Admin
+
+## Description
+
+Removes ottd bot permissions for given role in the guild.

docs/mkdocs/Commands/Roles/Get My Role.md

@@ -0,0 +1,14 @@
+# Get My Role
+
+## Syntax
+
+`/get-my-role`
+
+## Privilege required
+
+- Everyone
+
+
+## Description
+
+Gets your permission level for ottd bot on this guild.