serverk.yml

# yaml-language-server: $schema=./serverk.schema.json
schemaVersion: serverk.gg/v1
kind: GamePackage

metadata:
  id: minecraft-java
  name:
    ar: ماينكرافت جافا
    en: Minecraft Java
  description:
    ar: سيرفر ماينكرافت جافا الأصلي، يشتغل فور اكتمال طلبك دون أي إعداد.
    en: Minecraft Java Edition, vanilla and running the moment your order completes.
  tagline:
    ar: أشهر لعبة في العالم، وسيرفرك جاهز خلال دقيقة
    en: The world's biggest game, with your server ready in a minute
  category: sandbox
  logo: assets/logo.webp
  banner: assets/banner.webp
  extensions:
    - kind: mods
      sources:
        - modrinth
        - curseforge
    - kind: plugins
      sources:
        - modrinth
        - curseforge
        - hangar
    - kind: modpacks
      sources:
        - modrinth
        - curseforge

resources:
  minMemoryMb: 1024
  recommendedMemoryMb: 4096
  minDiskMb: 5120
  playersPerMemoryGb: 5

container:
  image: serverkgg/minecraft-java
  runtime:
    platform: linux
    installBudgetMinutes: 15
    bootBudgetMinutes: 12
    shmMb: 64
    pidsLimit: 512
  ports:
    - key: game
      containerPort: 25565
      protocol: tcp
      name:
        ar: جافا
        en: Java
      hint:
        ar: في ماينكرافت جافا، اكتب العنوان وحده في خانة السيرفر دون منفذ.
        en: In Minecraft Java, type the address alone in the server field, no port needed.
      hostRange:
        default: 25565
        min: 25565
        max: 25664
      srv:
        service: _minecraft
    - key: bedrock
      containerPort: 19132
      protocol: tcp+udp
      name:
        ar: بيدروك
        en: Bedrock
      hint:
        ar: في بيدروك، اكتب العنوان في خانة «عنوان السيرفر» والمنفذ في خانة «المنفذ».
        en: In Bedrock, type the address in the "Server Address" field and the port in the "Port" field.
      join: separate
      hostRange:
        default: 19132
        min: 19132
        max: 19231
      activeWhen:
        - variable: SERVER_TYPE
          values:
            - paper
            - purpur
            - fabric
            - neoforge
        - variable: CROSSPLAY
          values:
            - "true"
    - key: webrtc
      containerPort: 26200
      protocol: udp
      name:
        ar: بيدروك (NetherNet)
        en: Bedrock (NetherNet)
      hint:
        ar: منفذ بيدروك عبر NetherNet. يرسله سيرفرك بنفسه إلى لعبة اللاعب، ولا يكتبه اللاعبون في أي مكان.
        en: The Bedrock port for NetherNet. Your server sends it to the player's game by itself, and players don't type it anywhere.
      join: separate
      mirror: true
      hostRange:
        default: 26200
        min: 26200
        max: 26299
      activeWhen:
        - variable: SERVER_TYPE
          values:
            - paper
            - purpur
            - fabric
            - neoforge
        - variable: CROSSPLAY
          values:
            - "true"
    - key: voice
      containerPort: 26300
      protocol: udp
      name:
        ar: الصوت
        en: Voice
      hint:
        ar: منفذ الشات الصوتي. يضبطه سيرفرك بنفسه، ولا يكتبه اللاعبون في أي مكان.
        en: The voice chat port. Your server sets it up by itself, and players don't type it anywhere.
      join: separate
      mirror: true
      hostRange:
        default: 26300
        min: 26300
        max: 26399
      activeWhen:
        - variable: SERVER_TYPE
          values:
            - paper
            - purpur
            - fabric
            - forge
            - neoforge
        - variable: VOICE_CHAT
          values:
            - "true"
    - key: rcon
      containerPort: 25575
      protocol: tcp
      name:
        ar: RCON
        en: RCON
      hint:
        ar: للأدوات الخارجية فقط، ولا يدخل منه اللاعبون. يتفعّل عند تفعيل الوصول عن بُعد من اللوحة.
        en: For external tools only, never for players. It's live once you turn on remote access in the panel.
      join: separate
      hostRange:
        default: 12500
        min: 12500
        max: 12599
      activeWhen:
        - variable: RCON_EXPOSED
          values:
            - "true"

backup:
  except:
    - libraries/**
    - versions/**
    - logs/**
    - crash-reports/**
    - cache/**
    - .fabric/**
    - .serverk-staging/**
    - .serverk-uploads/**
    - .serverk-exports/**
    - server.jar
    - run.sh
    - run.bat
    - user_jvm_args.txt
    - backups/**
    - plugins/dynmap/web/tiles/**

secrets:
  - key: MODRINTH_API_KEY
    description:
      ar: مفتاح Modrinth API، ويرفع حدود الطلبات لكتالوج الإضافات والمودات.
      en: Modrinth API key. It raises the rate limits for the plugin and mod catalog.
    required: false
  - key: CURSEFORGE_API_KEY
    description:
      ar: مفتاح CurseForge API. بدونه يبقى مصدر CurseForge موقوفًا في كتالوج المودات وفي المودباكات.
      en: CurseForge API key. Without it, the CurseForge source stays off in both the mod catalog and the Modpacks tab.
    required: false
  - key: HANGAR_API_KEY
    description:
      ar: مفتاح Hangar API، ويرفع حدود الطلبات لكتالوج إضافات Paper.
      en: Hangar API key. It raises the rate limits for the Paper plugin catalog.
    required: false

reset:
  keep: []

presence:
  name: player
  avatar: "https://mc-heads.net/avatar/{skin}/128"
  fields:
    - key: platform
      label:
        ar: المنصة
        en: Platform

files:
  protected:
    - .serverk-staging/**
    - .serverk-install.json
    - .serverk-crashscan.json
    - .serverk-companions.json
    - .serverk-modpack.json
    - .serverk-client-pack.json
    - .serverk-packs/index.json
    - plugins/.serverk-catalog.json
    - mods/.serverk-catalog.json
  notable:
    - match: server.properties
      label:
        ar: إعدادات
        en: Settings
      icon: settings
      color: "#5ba32b"
      restart: true
      note:
        ar: "إعدادات السيرفر الأساسية: الاسم وعدد اللاعبين والصعوبة ووضع اللعب. أي تعديل يتطلب ريستارت."
        en: "The core server settings: name, player slots, difficulty and game mode. Any change needs a restart."
    - match: world
      label:
        ar: الماب
        en: World
      icon: map
      color: "#4a8fd4"
      note:
        ar: مابك. لا تحذفه إلا إذا كنت متأكدًا، وخذ نسخة احتياطية قبل أي تعديل.
        en: Your world. Don't delete it unless you're sure, and take a backup before you change it.
    - match: "world/**"
      label:
        ar: بيانات الماب
        en: World data
      icon: map
      color: "#4a8fd4"
      note:
        ar: جزء من بيانات الماب. تعديله والسيرفر شغّال قد يتلف حفظ اللعبة.
        en: Part of your world data. Editing it while the server runs can corrupt the save.
    - match: plugins
      label:
        ar: الإضافات
        en: Plugins
      icon: puzzle
      color: "#c77dff"
      restart: true
      note:
        ar: مجلد الإضافات. ضع ملفات jar هنا، وتشتغل بعد الريستارت.
        en: Your plugins folder. Drop jar files here. They load after a restart.
    - match: mods
      label:
        ar: المودات
        en: Mods
      icon: puzzle
      color: "#c77dff"
      restart: true
      note:
        ar: مجلد المودات. يلزم أن تكون لدى كل اللاعبين المودات نفسها ليتمكنوا من الدخول.
        en: Your mods folder. Every player needs the same mods to be able to join.
    - match: .serverk-packs
      label:
        ar: مودباكاتك المرفوعة
        en: Your uploads
      icon: box
      color: "#c77dff"
      note:
        ar: المودباكات التي رفعتها في تبويب المودباك. ثبّتها أو نزّلها أو احذفها من هناك.
        en: The modpacks you uploaded on the Modpacks tab. Install, download or delete them from there.
    - match: ops.json
      label:
        ar: الأدمن
        en: Admins
      icon: shield
      color: "#e0a458"
      note:
        ar: قائمة الأدمن. يستطيع من فيها استخدام أوامر الإدارة داخل اللعبة.
        en: The admin list. Anyone here can run operator commands in game.
    - match: whitelist.json
      label:
        ar: القائمة البيضاء
        en: Whitelist
      icon: users
      color: "#e0a458"
      note:
        ar: القائمة البيضاء. عند تفعيلها، لا يدخل إلا اللاعبون المضافون هنا.
        en: The whitelist. When it's on, only the players listed here can join.
    - match: banned-players.json
      label:
        ar: المحظورون
        en: Banned
      icon: shield
      color: "#d64545"
      note:
        ar: قائمة اللاعبين المحظورين.
        en: The list of banned players.
    - match: banned-ips.json
      label:
        ar: المحظورون
        en: Banned
      icon: shield
      color: "#d64545"
      note:
        ar: قائمة عناوين الـ IP المحظورة.
        en: The list of banned IP addresses.
    - match: "logs/**"
      label:
        ar: السجلات
        en: Logs
      icon: command
      color: "#8d99ae"
      note:
        ar: ملفات السجل. ارجع إليها عند حدوث خلل لمعرفة سببه.
        en: Log files. Check these when something breaks and you need to know why.

guideTags:
  - id: start
    name:
      ar: ابدأ من هنا
      en: Start here
  - id: features
    name:
      ar: مميزات
      en: Features

guides:
  - id: getting-started
    title:
      ar: البدء بسيرفرك
      en: Getting started
    summary:
      ar: من إنشاء السيرفر حتى دخول أول لاعب، خلال دقائق.
      en: From creating the server to the first player joining, all in minutes.
    tags:
      - start
    surfaces:
      - overview
      - console
      - setup
    bodyPath:
      ar: guides/getting-started/ar.md
      en: guides/getting-started/en.md
  - id: players
    title:
      ar: "اللاعبون: الأدمن والقائمة البيضاء والحظر"
      en: "Players: admins, the whitelist and bans"
    summary:
      ar: اجعل نفسك أدمن، وأغلق سيرفرك على أصحابك بالقائمة البيضاء، واطرد أو احظر من شئت، كل ذلك من صفحة اللاعبون.
      en: Make yourself an admin, keep your server to your friends with the whitelist, and kick or ban anyone, all from the Players page.
    tags:
      - start
    surfaces:
      - panel
      - console
    bodyPath:
      ar: guides/players/ar.md
      en: guides/players/en.md
  - id: settings
    title:
      ar: "الإعدادات: رسالة السيرفر والصعوبة ووضع اللعب"
      en: "Settings: MOTD, difficulty and game mode"
    summary:
      ar: ما تفعله كل خانة في تبويب الإعدادات، ومتى يلزمك الريستارت، والتغييرات الفورية من تبويب اللعب.
      en: What every field in the Settings tab does, when you need a restart, and the instant changes in the Gameplay tab.
    tags:
      - start
    surfaces:
      - panel
      - files
    bodyPath:
      ar: guides/settings/ar.md
      en: guides/settings/en.md
  - id: performance
    title:
      ar: "الأداء: أسباب اللاق وعلاجها"
      en: "Performance: what causes lag and how to fix it"
    summary:
      ar: على الباقات الصغيرة يأتي اللاق من المعالج لا من الرام. اضبط المدى، وولّد الماب مسبقًا بـ Chunky، واقرأ زمن التحديث بأمر واحد.
      en: On small plans, lag comes from the CPU, not the RAM. Set the distances, pre-generate the world with Chunky, and read the tick time with one command.
    tags:
      - start
    surfaces:
      - overview
      - panel
      - console
    bodyPath:
      ar: guides/performance/ar.md
      en: guides/performance/en.md
  - id: plugins-mods
    title:
      ar: "الإضافات والمودات: ثبّتها من اللوحة"
      en: "Plugins and mods: install them from the panel"
    summary:
      ar: ثبّت الإضافات والمودات من Modrinth و CurseForge و Hangar مع متطلباتها، وحدّثها وأوقفها، وارفع ملفاتك بنفسك.
      en: Install plugins and mods from Modrinth, CurseForge and Hangar with their dependencies, update and turn them off, and upload your own files.
    tags:
      - start
      - features
    surfaces:
      - panel
      - files
    bodyPath:
      ar: guides/plugins-mods/ar.md
      en: guides/plugins-mods/en.md
  - id: server-type
    title:
      ar: "نوع السيرفر والإصدار: ما يحدث لمابك"
      en: "Server type and version: what happens to your world"
    summary:
      ar: انتقل بين Vanilla و Paper و Purpur و Fabric و Forge و NeoForge، أو غيّر إصدارك، وأنت تعرف ما يبقى وما يُحذف.
      en: Move between Vanilla, Paper, Purpur, Fabric, Forge and NeoForge, or change your version, knowing what stays and what goes.
    tags:
      - features
    surfaces:
      - overview
      - panel
    bodyPath:
      ar: guides/server-type/ar.md
      en: guides/server-type/en.md
  - id: crossplay
    title:
      ar: "الكروس بلاي: لاعبو بيدروك في سيرفرك"
      en: "Crossplay: Bedrock players on your server"
    summary:
      ar: فعّل مفتاحًا واحدًا، ويدخل أصحابك من الجوال والكونسول وويندوز إلى سيرفر جافا الخاص بك.
      en: Turn on one switch and let friends on phone, console and Windows join your Java server.
    tags:
      - features
    surfaces:
      - overview
      - panel
    bodyPath:
      ar: guides/crossplay/ar.md
      en: guides/crossplay/en.md
  - id: voice-chat
    title:
      ar: "الشات الصوتي: تحدّث مع أصحابك داخل اللعبة"
      en: "Voice chat: talk to your friends in game"
    summary:
      ar: فعّل مفتاحًا واحدًا، ونثبّت Simple Voice Chat ونفتح منفذه ونضبطه لك، ويثبّت كل لاعب المود نفسه على جهازه.
      en: Turn on one switch and we install Simple Voice Chat, open its port and set it up for you. Each player installs the same mod on their computer.
    tags:
      - features
    surfaces:
      - overview
      - panel
    bodyPath:
      ar: guides/voice-chat/ar.md
      en: guides/voice-chat/en.md
  - id: modpacks
    title:
      ar: "المودباك: سيرفر جاهز بضغطة"
      en: "Modpacks: a ready-made server in one click"
    summary:
      ar: اختر مودباكًا من الكتالوج، ونثبّت مودات المودباك وإعداداته ونجهّز سيرفرك عليه.
      en: Pick a modpack from the catalog and we install its mods and configs and set your server up for it.
    tags:
      - features
    surfaces:
      - overview
      - panel
    bodyPath:
      ar: guides/modpacks/ar.md
      en: guides/modpacks/en.md
  - id: version-compat
    title:
      ar: "توافق الإصدارات: إصدارات جافا الأخرى في سيرفرك"
      en: "Version compatibility: other Java versions on your server"
    summary:
      ar: فعّل مفتاحًا واحدًا، ويدخل أصحابك بإصدار جافا أحدث أو أقدم من إصدار سيرفرك.
      en: Turn on one switch and let friends join on a Java version newer or older than your server.
    tags:
      - features
    surfaces:
      - overview
      - panel
    bodyPath:
      ar: guides/version-compat/ar.md
      en: guides/version-compat/en.md
  - id: worlds
    title:
      ar: "المابات: التبديل والرفع والريسيت"
      en: "Worlds: switch, upload and reset"
    summary:
      ar: بدّل الماب المفعّل، وارفع ماب من جهازك، ونفّذ ريسيت للماب بالسيد نفسه أو من نسخة تحتفظ بها أو للنذر والإند فقط، واحذف ما لا تحتاجه.
      en: Switch the active world, upload one from your computer, reset the world from its seed or from a copy you keep, or just the Nether and the End, and delete what you don't need.
    tags:
      - features
    surfaces:
      - panel
      - files
      - backups
    bodyPath:
      ar: guides/worlds/ar.md
      en: guides/worlds/en.md