# SyAPI<\/p>\n
SyAPI is a server statistics API plugin for Minecraft Purpur\/Paper 1.21.1, providing server runtime status, player statistics, and more.<\/p>\n
## Features<\/p>\n
– \ud83d\udcca Server uptime statistics
\n– \ud83d\udcc8 Yesterday’s login count statistics
\n– \ud83d\udc65 Historical maximum online players record
\n– \ud83d\udcdd Total login count statistics
\n– \u26a1 Server minimum TPS monitoring
\n– \ud83c\udf10 Player latency detection (highest latency player)<\/p>\n
## Supported Versions<\/p>\n
– **Server**: Paper, Purpur 1.21.1
\n– **Java Version**: Java 17+
\n– **API Version**: 1.21<\/p>\n
## Usage<\/p>\n
### Commands<\/p>\n
| Command | Description | Permission |
\n|———|————-|————|
\n| `\/syapi` | View server statistics | `syapi.use` |
\n| `\/syapi info` | View server statistics | `syapi.use` |
\n| `\/syapi reload` | Reload plugin configuration | `syapi.admin` |
\n| `\/syapi help` | Display help information | `syapi.use` |<\/p>\n
### API Usage<\/p>\n
Other plugins can call SyAPI in the following way:<\/p>\n
“`java
\nimport cn.shiyuan.syapi.SyAPI;
\nimport cn.shiyuan.syapi.SyAPIProvider;<\/p>\n
\/\/ Get API provider
\nSyAPI syapi = SyAPI.getInstance();
\nSyAPIProvider api = syapi.getApiProvider();<\/p>\n
\/\/ Get server start time
\nlong startTime = api.getServerStartTimeMillis();
\nString uptime = api.getServerUptime();
\nString startTimeFormatted = api.getServerStartTimeFormatted();<\/p>\n
\/\/ Get player statistics
\nint yesterdayJoins = api.getYesterdayJoinCount();
\nint maxOnline = api.getMaxOnlinePlayers();
\nint totalJoins = api.getTotalJoinCount();<\/p>\n
\/\/ Get server performance data
\ndouble minTps = api.getMinTps();<\/p>\n
\/\/ Get latency information
\nPlayer highestLatencyPlayer = api.getHighestLatencyPlayer();
\nString playerName = api.getHighestLatencyPlayerName();
\nlong highestLatency = api.getHighestLatency();
\nlong playerLatency = api.getPlayerLatency(player);
\n“`<\/p>\n
### API Method Reference<\/p>\n
#### Server Time Related<\/p>\n
| Method | Return Value | Description |
\n|——–|————–|————-|
\n| `getServerStartTimeMillis()` | `long` | Get server start timestamp (milliseconds) |
\n| `getServerUptime()` | `String` | Get server uptime (formatted string, e.g., “2 days 5 hours 30 minutes”) |
\n| `getServerStartTimeFormatted()` | `String` | Get server start time (formatted date, e.g., “2026-04-03 12:30:00”) |<\/p>\n
#### Player Statistics Related<\/p>\n
| Method | Return Value | Description |
\n|——–|————–|————-|
\n| `getYesterdayJoinCount()` | `int` | Get yesterday’s login count (unique players) |
\n| `getMaxOnlinePlayers()` | `int` | Get historical maximum online players |
\n| `getTotalJoinCount()` | `int` | Get total login count |<\/p>\n
#### Server Performance Related<\/p>\n
| Method | Return Value | Description |
\n|——–|————–|————-|
\n| `getMinTps()` | `double` | Get server minimum TPS |
\n| `getHighestLatencyPlayer()` | `Player` | Get player object with highest latency |
\n| `getHighestLatencyPlayerName()` | `String` | Get name of player with highest latency |
\n| `getHighestLatency()` | `long` | Get maximum latency value (milliseconds) |
\n| `getPlayerLatency(Player player)` | `long` | Get specified player’s latency (milliseconds) |<\/p>\n
## Project Structure<\/p>\n
“`
\nSyAPI\/
\n\u251c\u2500\u2500 src\/
\n\u2502 \u2514\u2500\u2500 main\/
\n\u2502 \u251c\u2500\u2500 java\/cn\/shiyuan\/syapi\/
\n\u2502 \u2502 \u251c\u2500\u2500 SyAPI.java # Main class
\n\u2502 \u2502 \u251c\u2500\u2500 SyAPIProvider.java # API provider
\n\u2502 \u2502 \u251c\u2500\u2500 StatsManager.java # Statistics manager
\n\u2502 \u2502 \u251c\u2500\u2500 PlayerListener.java # Player event listener
\n\u2502 \u2502 \u2514\u2500\u2500 SyAPICommand.java # Command handler
\n\u2502 \u2514\u2500\u2500 resources\/
\n\u2502 \u251c\u2500\u2500 plugin.yml # Plugin configuration
\n\u2502 \u2514\u2500\u2500 data.yml # Data storage
\n\u251c\u2500\u2500 pom.xml # Maven configuration
\n\u2514\u2500\u2500 README.md # Documentation
\n“`<\/p>\n
## Permission Nodes<\/p>\n
| Permission | Description | Default |
\n|————|————-|———|
\n| `syapi.admin` | Admin permissions (reload, etc.) | OP |
\n| `syapi.use` | Usage permissions (view statistics) | All players |<\/p>\n
## Data Storage<\/p>\n
The plugin uses YAML files to store data, located at `plugins\/SyAPI\/data.yml`:<\/p>\n
– `total-join-count`: Total login count
\n– `max-online-players`: Historical maximum online players
\n– `yesterday-join-count`: Yesterday’s login count
\n– `today-join-count`: Today’s login count (automatically resets daily)
\n– `current-date`: Current date
\n– `yesterday-players`: Yesterday’s player UUID list<\/p>\n
## Scheduled Tasks<\/p>\n
The plugin automatically runs the following scheduled tasks after startup:<\/p>\n
– **TPS Monitoring**: Updates minimum TPS every second
\n– **Latency Update**: Updates player latency data every second
\n– **Date Check**: Checks for date changes every minute, automatically resets today’s statistics
\n– **Data Save**: Automatically saves data to file every 5 minutes<\/p>\n","protected":false},"excerpt":{"rendered":"
Provides some obscure APIs for the development of other plugins<\/p>\n","protected":false},"featured_media":0,"template":"","meta":{"_minecraft_slug":"syapi","_minecraft_project_id":"RL7GBkJw","_minecraft_author":"Shiyuan","_minecraft_license":"MIT","_minecraft_downloads":6,"_minecraft_follows":1,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"syapi.zip","_minecraft_size_bytes":11795,"_minecraft_version_count":1,"_minecraft_updated_at":"2026-05-16T12:29:47.657356Z","_minecraft_date_created":"2026-04-03T22:31:07.285568Z","_minecraft_date_modified":"2026-04-03T12:41:49.629987Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/syapi","_minecraft_icon_attachment_id":0,"_minecraft_imported_at":"2026-06-09T03:12:05+00:00","_minecraft_import_hash":"de2f24956a6fa9a2994166f39887dbab","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[89,873,126,127,128,91,92],"mod_loader":[132,133],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82],"class_list":["post-151374","mod","type-mod","status-publish","hentry","mod_category-game-mechanics","mod_category-library","mod_category-management","mod_category-paper","mod_category-purpur","mod_category-storage","mod_category-utility","mod_loader-paper","mod_loader-purpur","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9"],"yoast_head":"\n