Skip to content
This repository has been archived by the owner on Feb 26, 2021. It is now read-only.

Commit

Permalink
Add some meat to README
Browse files Browse the repository at this point in the history
  • Loading branch information
NeonWizard authored Dec 2, 2018
1 parent 8cbfbae commit 09913b0
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,22 @@
# SCP-DisconnectDrop
A simple plugin for SCP:SL Smod2 servers, which drops a player's inventory in the event that they are disconnected. An example of when this is useful is when the only person with keycards in 914 times out. Without this plugin, all other players in 914 would be trapped indefinitely. It operates by lightweight caching minimal player information every so often, of which the interval is configurable.

## Plugin Installation
To install:
1. Grab newest version of DisconnectDrop: [Latest Release](https://github.com/NeonWizard/SCP-DisconnectDrop/releases/latest)
2. Navigate to your SCP Secret Lab folder.
3. Drag DisconnectDrop.dll into the sm_plugins folder.

## Servermod (This is required for any plugin)
ServerMod is a server side plugin system with a bunch of additional configuration options, bug fixes, security patches and some optimisations built in.
* SMOD can be found here: [Smod Github](https://github.com/Grover-c13/Smod2)
* SMOD Discord: https://discord.gg/8nvmMTr

## Configuration
Config Option | Value Type | Default Value | Description
--- | :---: | :---: | ---
ddrop_inventory_refreshrate | Int | 1 | How often player inventories are cached (in seconds).

*Note that all configs should go in your server config file, not config_remoteadmin.txt

### Place any suggestions/problems in [issues](https://github.com/NeonWizard/SCP-DisconnectDrop/issues)!

0 comments on commit 09913b0

Please sign in to comment.