# Investigate

## Configuration

```yaml
investigations-module:
    enabled: true
    allow-offline-investigation: false
    # How many investigations can be conducted on one player at a time.
    # By default only one investigation can be ongoing for one player
    max-concurrent-investigations: 1
    # When enabled investigations will automatically be paused 
    # when the player under investigation leaves the server.
    automatic-pause: true
    notifications:
        investigated:
            # Player under investigation has a constant message in his action bar. 
            title-message-enabled: true
            # Player under investigation has a constant message in his action bar.
            chat-message-enabled: true
    # Run commands whenever an investigation open/pauses/isConcluded        
    start-investigation-commands: []
    conclude-investigation-commands: []
    pause-investigation-commands: []
```

## Commands

| command                               | description                                                                                                 |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| /investigate \<player>                | Open/resume an investigation                                                                                |
| /pause-investigation                  | Pause your currently ongoing investigation                                                                  |
| /conclude-investigation               | Conclude your investigation. This closes the investigation                                                  |
| /manage-investigations \<playername?> | Opens up the overview of all investigations or all investigation for a player if the playername is provided |
| /inote \<notemessage>                 | Add a note to your current investigation                                                                    |

## Permissions

| permission                                    | Description                                       |
| --------------------------------------------- | ------------------------------------------------- |
| staff.investigation.manage.investigate        | allows the use of /investigate                    |
| staff.investigation.manage.notifications      | Get all staff notifications for investigations    |
| staff.investigation.manage.view               | Allow viewing all investigations                  |
| staff.investigation.manage.link-evidence      | Allow linking evidence to investigations          |
| staff.investigation.manage.add-note           | Allow adding notes to investigations              |
| staff.investigation.manage.delete-note        | Allow deleting your own notes from investigations |
| staff.investigation.manage.delete-note-others | Allow deleting any note from investigations       |

## Manage investigation

Staff members can view an overview of all investigations.

![Investigations](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MXZe8eUusNpZxAWNiU0%2F-MXZeVSqhu-RLiTnKp02%2Finvestigations_overview.PNG?alt=media\&token=bff7bc4d-101e-4d78-98f4-e55374d15132)

![Player under investigation](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MXZgY37u1bjVHsvYR0B%2F-MXZldJTZWAEbulipIuk%2Funder_investigation.PNG?alt=media\&token=f27a7ef1-5167-4a8c-98ea-8a732af80f14)

## Linking evidence

Staff++ allows you to link certain infractions to an investigation.

Currently following infractions can be linked to investigations:

* Reports
* Mutes
* Bans
* Warnings

Developers can also link any other kind of evidence using the [Developer API](https://wiki.staffplusplus.org/master/developers/api-guide)

![Link report as evidence](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MXZbSJmFSJYYppGipWD%2F-MXZc6hyBOZQx41Xnidf%2Finvestigation_link_evidence.PNG?alt=media\&token=e2ad9f9d-2a7a-4663-a7cb-88c28356b90f)

![Confirmation evidence linked](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MXZbSJmFSJYYppGipWD%2F-MXZcNaJWCC-u5KqlsbM%2Fevidence_link_chatmessage.PNG?alt=media\&token=2ea77d46-4868-4448-8d7b-892691643153)

![Investigation manage screen](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MXZbSJmFSJYYppGipWD%2F-MXZcdAmDtm94AdSu3P3%2Fgo_to_evidence_overview.PNG?alt=media\&token=5be2bd3e-21f0-495a-b7e5-c85aa2d6a25f)

![Evidence overview](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MXZce50KhM9aik6oE4i%2F-MXZcn77BaDDjSZDbOJW%2Fevidence_overview.PNG?alt=media\&token=7a632001-ff03-4edd-b29b-a978abf1d503)

## Taking notes

Players can add notes to an investigation.

![Go to notes](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MXZce50KhM9aik6oE4i%2F-MXZe1wvEqhA98QfF9pO%2Fgo_to_notes_overview.PNG?alt=media\&token=b400da64-43b5-4de5-a3c2-d55c476f6cf4)

![Notes overview](https://292687455-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MPQohtcLxhXAvpSXOMt%2F-MXZce50KhM9aik6oE4i%2F-MXZe6XYpjxw9K8Z0Hrc%2Fnote_overview.PNG?alt=media\&token=9edf86a2-8552-4a39-b3a3-faae4118c834)