Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miciasty/enhanced-surveillance
Spigot/Paper plugin that monitors and logs all in-game events for complete server oversight
https://github.com/miciasty/enhanced-surveillance
java minecraft minecraft-plugin paper spigot surveillance
Last synced: about 1 month ago
JSON representation
Spigot/Paper plugin that monitors and logs all in-game events for complete server oversight
- Host: GitHub
- URL: https://github.com/miciasty/enhanced-surveillance
- Owner: Miciasty
- License: mit
- Created: 2024-08-06T14:40:46.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-07T19:32:19.000Z (2 months ago)
- Last Synced: 2024-10-11T03:40:31.330Z (about 1 month ago)
- Topics: java, minecraft, minecraft-plugin, paper, spigot, surveillance
- Language: Java
- Homepage:
- Size: 559 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Enhanced Surveillance
Enhanced Surveillance is a Minecraft plugin that logs all player activities for detailed and organized record-keeping. It stores player events information in a database, providing a reliable way to monitor player actions and keep your server secure.
## Getting Started
- [Configuration](#configuration)
- [Commands](#commands)
- [Support](#support)
## Configuration
To configure the Enhanced Surveillance plugin, edit the `config.yml` file located in the plugin's directory. To configure each event listener, edit the `bukkit-events.yml` and `paper-events.yml` located in `events/player` directory.
### `config.yml`
- ### Database Configuration
This section configures the database connection parameters used by the plugin to store and retrieve data.
- **dialect** - Specifies the database dialect. For example, ***MySQL8Dialect*** for MySQL.
- **address** - The IP address or hostname of the database server.
- **port** - The port on which the database server is listening.
- **database** - The name of the database.
- **username** - The username used to connect to the database.
- **password** - The password used to connect to the database.
```yml
database:
dialect: MySQL8Dialect
address: localhost
port: 3306
database: enhanced_surveillance
username: root
password: ""
```
- ### Hibernate Configuration
This section contains Hibernate-specific settings.
- **show_sql** - If set to true, SQL statements will be logged to the console.
- **format_sql** - If set to true, SQL statements will be formatted.
- **sql_comments** - If set to true, SQL comments will be included in the logged SQL statements.
```yml
hibernate:
show_sql: false
format_sql: true
sql_comments: true
```
- ### MemoryService Configuration
This section contains asynchronous service-specific settings.
- **services** - Amount of independent services.
- **threads** - Amount of threads per service.
```yml
memory-service: # 5 (services) * 3 (threads) = 15 (threads usage)
services: 3
threads: 1
```
> [!TIP]
> It's recommended to start with 1 service and 2-3 threads. As the number of players increases, consider adding a second service or increasing the thread count to handle the additional load effectively. Begin with a lower configuration and adjust based on actual performance and load monitoring.
###
### `bukkit/paper-events.yml`
> [!WARNING]
> It is highly recommended not to use levels higher than 0 or 1 unless absolutely necessary, such as for debugging or when there is a critical need to capture all details of an event.
> [!CAUTION]
> As the record level increases, the size of each event also grows significantly—potentially up to 500 bytes at the highest levels in some Events. Given that events can be generated in large numbers every second, this can quickly lead to excessive database storage consumption, risking the exhaustion of available disk space.
- ### Event listener
This is example of section inside `bukkit-events.yml` and `paper-events.yml`, each listener will contain at least 2 parameters.
- **enabled** - If set to true, EventListener will be active.
- **level** - Specifies level of information to record.
```yml
PlayerInteractEntityEvent:
enabled: false
level: 1 # Levels: 0 / 1 / 2 / 3
```
- ### Event listener (with additional parameters)
This is example of section inside `bukkit-events.yml` and `paper-events.yml`, this listener contain more than 2 parameters. However in the comment behind you can read it's purpose.
- **enabled** - If set to true, EventListener will be active.
- **level** - Specifies level of information to record.
- **distance** - Specifies distance the player have to reach from last position to record new Event.
```yml
PlayerMoveEvent:
enabled: true
level: 3 # Levels: 0 / 1 / 2 / 3
distance: 15 # Not-Recommended lower numbers than 15
```
---
## Support
For questions about Enhanced Surveillance, first try the ~~[Wiki](https://example.com/)~~ to see if your question is already answered there.
If you can't find what you're looking for, contact me via Discord ***.n.u*** or ***❤ Miciasty ❤***
### Work in progress...
(╯°□°)╯︵ ┻━┻