Skip to content

Commit

Permalink
Update README.md for 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
IkaOverride authored Sep 29, 2023
1 parent f2df191 commit b25b57a
Showing 1 changed file with 53 additions and 17 deletions.
70 changes: 53 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,64 @@
# ShootingInteractions
Exiled [SCP: Secret Laboratory] plugin

Feel free to make suggestions
New interactions when shooting on objects!
(If there's any issues, if you have any suggestions or if you want to help me improve the code feel free to DM me or open a github issue)
Discord : @ika7533

# Features
* Interact with door when a player is shooting on one of its buttons (Disable in config)
* Remote Keycard (Open keycard doors if the player has the right keycard in their inventory when shooting on it) (Enable in config, otherwise it nevers open)
* Keycard bypass support
* Interact with elevator when a player is shooting on one of its buttons (Disable in config)
* Random chance for buttons to "break" when shooting on it, can configure for how long, and can configure if the door should do its animation before the buttons breaking (Enable in config)
* Make grenade explode when a player shoots on it (Disable in config)
* Interact with doors by shooting on their buttons
* Remote Keycard (Check keycards in the player's inventory to open doors that requires a keycard)
* Interact with elevators by shooting on their buttons
* Random chance for buttons to "break" when shooting on them, you can configure for how long, and if the door/elevator should move before the buttons break
* Interact with bulletproof lockers (SCP Lockers) when shooting on their keycard reader
* Bypass support
* Make frag grenades and flashbangs explode when shooting on them, and choose if they explode instantly or not
* Make SCP-2176 shatter when shooting on it

# Config
| Config | Type | Default | Description |
| :-------------: | :---------: | :---------: | :---------:
| is_enabled | bool | true | Indicates whether the plugin is enabled or not
| debug | bool | false | Indicates whether the plugin's debug logs are enabled or not
| doors | bool | true | Should the plugin work with doors
| door_check_keycard | bool | false | Should the plugin work with keycard doors? (false = never opens, true = opens if the keycard is in their inventory)
| door_buttons_break_chance | byte | 0 | Percentage of chance for a door's buttons to break (0 = never break, 100 = always break)
| door_move_before_breaking | bool | true | Let the door move before breaking the buttons
| door_buttons_break_time | float | 15 | For how long should the door's buttons stay broken (0 = infinite)
| elevators | bool | true | Should the plugin work with elevators
| elevator_buttons_break_chance | byte | 0 | Percentage of chance for an elevator's buttons to break (0 = never break, 100 = always break)
| elevator_move_before_breaking | bool | false | Let the elevator move before breaking the buttons
| elevator_buttons_break_time | float | 15 | For how long should the elevator's buttons stay broken (0 = infinite)
| grenades | bool | false | Should the plugin work with grenades
| doors | DoorInteraction | See DoorInteraction config | Normal doors buttons
| checkpoints | DoorInteraction | See DoorInteraction config | Checkpoint doors buttons
| gates | DoorInteraction | See DoorInteraction config | Gates buttons
| bulletproof_lockers | LockerInteraction | See LockerInteraction config | Bulletproof lockers keycard readers
| elevators | ElevatorInteraction | See ElevatorInteraction config | Elevators buttons
| frag_grenades | TimedProjectileInteraction | See TimedProjectileInteraction config | Frag grenades
| flashbangs | TimedProjectileInteraction | See TimedProjectileInteraction config | Flashbangs
| scp2176 | ProjectileInteraction | See ProjectileInteraction config | SCP-2176

# DoorInteraction Config
| Config | Type | Default | Description |
| :-------------: | :---------: | :---------: | :---------:
| is_enabled | bool | true | Is the shooting interaction enabled
| remote_keycard | bool | false | Does the interaction check keycards in the player's inventory
| buttons_break_chance | byte | 0 | Percentage of chance for the buttons to break
| buttons_break_time | float | 10 | For how long should the buttons stay broken
| move_before_breaking | bool | true | Should the door still move/do its animation if the buttons should break

# LockerInteraction Config
| Config | Type | Default | Description |
| :-------------: | :---------: | :---------: | :---------:
| is_enabled | bool | true | Is the shooting interaction enabled
| remote_keycard | bool | true | Does the interaction check keycards in the player's inventory

# ElevatorInteraction Config
| Config | Type | Default | Description |
| :-------------: | :---------: | :---------: | :---------:
| is_enabled | bool | true | Is the shooting interaction enabled
| buttons_break_chance | byte | 0 | Percentage of chance for the buttons to break
| buttons_break_time | float | 10 | For how long should the buttons stay broken
| move_before_breaking | bool | true | Should the door still move/do its animation if the buttons should break

# TimedProjectileInteraction Config
| Config | Type | Default | Description |
| :-------------: | :---------: | :---------: | :---------:
| is_enabled | bool | true | Is the shooting interaction enabled
| explode_instantly | bool | false | Should the projectile explode instantly

# ProjectileInteraction Config
| Config | Type | Default | Description |
| :-------------: | :---------: | :---------: | :---------:
| is_enabled | bool | true | Is the shooting interaction enabled

0 comments on commit b25b57a

Please sign in to comment.