Skip to content

Commit

Permalink
Update Installation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KarlOfDuty authored Dec 28, 2022
1 parent 4827734 commit 8812474
Showing 1 changed file with 13 additions and 40 deletions.
53 changes: 13 additions & 40 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,52 +12,32 @@ Extract the bot anywhere you wish outside of the server directory.

### **Plugin:**

Extract the plugin and dependencies directory into the `<server_dir>/sm_plugins` directory:
Extract the plugin and dependencies directory into the `PluginAPI/plugins/<port>` directory:
```
sm_plugins/
dependencies/
Google.Protobuf.dll
Newtonsoft.Json.dll
YamlDotNet.dll
SCPDiscord.dll
plugins/
<port>/
dependencies/
Google.Protobuf.dll
Newtonsoft.Json.dll
YamlDotNet.dll
SCPDiscord.dll
```

----

## 2. Server config

This plugin does not use the server config for configuration like most others, instead it has it's own plugin config in your config directory.

The only thing configured in the server config is where to place the plugin's files:

| Name (in config_gameplay.txt) | Default value | Description |
|-------------------------------|:-------------:|----------------------------------------------------------------------------------------------------------|
| `scpdiscord_config_global` | `true` | Decides whether to place the plugin config in the global config directory instead of the local one. |
| `scpdiscord_rolesync_global` | `true` | Decides whether to place the rolesync data in the global config directory instead of the local one. |
| `scpdiscord_languages_global` | `true` | Decides whether to place the language directory in the global config directory instead of the local one. |

Depending on how you have set up your server the local config directory should be in `<server_dir>/servers/servername/` for multiadmin servers or `~/config/SCP Secret Laboratory/config/<server_port>/` for localadmin servers and multiadmin servers if you do not create the local server directory.

The global config directory is most likely in `~/config/SCP Secret Laboratory` on linux or `%Appdata%/SCP Secret Laboratory` on windows.
## 2. Plugin config

The plugin config is automatically created for you the first time you run the plugin. The path is printed in the server console on startup so you know for sure where it is.

----

## 3. Plugin config

[Click here to view default config](https://github.com/KarlOfDuty/SCPDiscord/blob/master/SCPDiscordPlugin/config.yml)

Remember to set the bot port to something **different from the scpsl server port**, or everything will break.

Remember this port as you will need to put it in the bot config too.

**Note:** Keeping the bot and plugin on different devices is not supported but is possible, you will have to deal with the issues this may result in yourself if you choose to do so.
Simply change the bot ip in the config below to correspond with the other device.
Simply change the bot ip in the plugin config to correspond with the other device.

----

## 4. Bot setup and config:
## 3. Bot setup and config:

### Bot setup:

Expand All @@ -76,6 +56,7 @@ Run the bot using:
# Windows
./SCPDiscordBot.exe
```
If you are unable to run the bot make sure the file has correct permissions and try installing dotnet 7.0.

----

Expand All @@ -85,14 +66,6 @@ Run the bot using:

# Other important information

----

**If you have download the bot directly from the repo** rather than from the releases tab or dev builds you have to make a copy of `default_config.yml` and name it `config.yml`.

This is to make sure I or anyone else who adds to this bot don't accidentally post their bot token or other sensitive information in the public repository.

----

**SECURITY WARNING:**

**The bot has no authorization of incoming connections**, this means you cannot allow the plugin's port through your firewall or anyone will be able to send fake messages to it.
Expand All @@ -114,4 +87,4 @@ It gives others full access to the bot's Discord account so they can use it to d

It is also highly recommended to make sure the bot only has the necessary Discord permissions and no more in order to limit the damage if you accidentally post your bot token somewhere.

----
----

0 comments on commit 8812474

Please sign in to comment.