راهنمای استفاده و توضیحات (README)
<p class="ds-markdown-paragraph" style="margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">ScoreHud</span></p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);">An event-driven, highly customizable plugin to add scoreboards on your PocketMine-MP server.</p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">What does this plugin do?</span></p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);">ScoreHud adds a fully customizable scoreboard (side HUD) to your server. It is completely event-driven, offers a simple API for developers, and supports many built-in tags for displaying player and server information.</p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">Features</span></p><ul style="margin-top: 16px; margin-bottom: 16px; padding-left: 18px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><li><p class="ds-markdown-paragraph">Adds a scoreboard to your server</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Completely event-driven – no recurring tasks</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Everything is customizable via config files</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Simple API for developers</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Built-in tags for player name, health, XP, world, online players, TPS, ping, and more</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Supports per-world scoreboards</p></li></ul><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">Commands</span></p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);">/scorehud – Main command for reloading configuration or managing scoreboards – permission: sh.command.sh</p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">Permissions</span></p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);">sh.command.sh – default: true – Allows players to use /scorehud (reload config, etc.)</p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">Available Tags (examples)</span></p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);">{<a href="https://scorehud.name/" target="_blank" rel="noreferrer" style="color: rgb(103, 158, 254); transition: box-shadow 0.2s cubic-bezier(0.4, 0, 0.2, 1); border-width: 2px 3px; border-style: solid; border-color: rgba(255, 255, 255, 0); margin-left: -3px; margin-right: -3px; text-decoration-line: none; position: relative;">scorehud.name</a>} – Player name<br>{scorehud.health} – Current health<br>{scorehud.max_health} – Maximum health<br>{scorehud.xp_level} – Current XP level<br>{scorehud.xp_progress} – XP progress percentage<br>{<a href="https://scorehud.online/" target="_blank" rel="noreferrer" style="color: rgb(103, 158, 254); transition: box-shadow 0.2s cubic-bezier(0.4, 0, 0.2, 1); border-width: 2px 3px; border-style: solid; border-color: rgba(255, 255, 255, 0); margin-left: -3px; margin-right: -3px; text-decoration-color: rgb(103, 158, 254); position: relative; outline: none;">scorehud.online</a>} – Number of players online<br>{scorehud.max_online} – Max server capacity<br>{scorehud.tps} – Current server TPS<br>{<a href="https://scorehud.world/" target="_blank" rel="noreferrer" style="color: rgb(103, 158, 254); transition: box-shadow 0.2s cubic-bezier(0.4, 0, 0.2, 1); border-width: 2px 3px; border-style: solid; border-color: rgba(255, 255, 255, 0); margin-left: -3px; margin-right: -3px; text-decoration-line: none; position: relative;">scorehud.world</a>_name} – Current world name<br>{<a href="https://scorehud.world/" target="_blank" rel="noreferrer" style="color: rgb(103, 158, 254); transition: box-shadow 0.2s cubic-bezier(0.4, 0, 0.2, 1); border-width: 2px 3px; border-style: solid; border-color: rgba(255, 255, 255, 0); margin-left: -3px; margin-right: -3px; text-decoration-line: none; position: relative;">scorehud.world</a>_player_count} – Players in current world<br>{scorehud.ping} – Player ping<br>{scorehud.date} – Current date<br>{scorehud.time} – Current time</p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);">You can find more tags in the ScoreHudX repository.</p><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">Installation</span></p><ol start="1" style="margin-top: 16px; margin-bottom: 16px; padding-left: 18px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><li><p class="ds-markdown-paragraph">Download ScoreHud.phar (API 5 compatible version).</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Put the .phar into the plugins folder.</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Start and then stop the server to generate config files.</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Edit <code style="font-variant-numeric: normal; font-variant-east-asian: normal; font-variant-alternates: normal; font-variant-position: normal; font-variant-emoji: normal; font-stretch: 100%; line-height: 22px; font-optical-sizing: auto; font-size-adjust: none; font-kerning: auto; font-feature-settings: normal; font-variation-settings: normal; font-language-override: normal; font-family: Menlo, Monaco, Consolas, "Cascadia Mono", "Ubuntu Mono", "DejaVu Sans Mono", "Liberation Mono", "JetBrains Mono", "Fira Code", Cousine, "Roboto Mono", "Courier New", Courier, sans-serif, system-ui; background-color: rgb(44, 44, 46); border-radius: 6px; align-items: center; padding: 0px 5px; display: inline-flex; font-size: 0.875em !important;">config.yml</code> and <code style="font-variant-numeric: normal; font-variant-east-asian: normal; font-variant-alternates: normal; font-variant-position: normal; font-variant-emoji: normal; font-stretch: 100%; line-height: 22px; font-optical-sizing: auto; font-size-adjust: none; font-kerning: auto; font-feature-settings: normal; font-variation-settings: normal; font-language-override: normal; font-family: Menlo, Monaco, Consolas, "Cascadia Mono", "Ubuntu Mono", "DejaVu Sans Mono", "Liberation Mono", "JetBrains Mono", "Fira Code", Cousine, "Roboto Mono", "Courier New", Courier, sans-serif, system-ui; background-color: rgb(44, 44, 46); border-radius: 6px; align-items: center; padding: 0px 5px; display: inline-flex; font-size: 0.875em !important;">scorehud.yml</code> to customize your scoreboard.</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">Restart the server.</p></li></ol><p class="ds-markdown-paragraph" style="margin-top: 16px; margin-bottom: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">Requirements</span></p><ul style="margin-top: 16px; margin-bottom: 16px; padding-left: 18px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><li><p class="ds-markdown-paragraph">PocketMine-MP API 5.0.0</p></li><li style="margin-top: 6px;"><p class="ds-markdown-paragraph">PHP 7.4 or higher</p></li></ul><p class="ds-markdown-paragraph" style="margin-top: 16px; color: rgb(249, 250, 251); font-family: quote-cjk-patch, Inter, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue", sans-serif; font-size: 16px; background-color: rgb(21, 21, 23);"><span style="font-weight: 600;">Version</span> 8.0.0 – by Ifera.</p>