GitHub

Начало работыGetting started

Установка мода, папка scriptcraft/, первый скрипт, команды перезагрузки и конфиг. Installing the mod, the scriptcraft/ folder, your first script, reload commands and config.

1. Установка1. Install

  • Нужны Minecraft 1.20.1 и Forge 47.x (Java 17).
  • Положите scriptcraft-<версия>.jar в папку mods сервера и всех клиентов: экраны, свои блоки и раздача текстур работают только если мод есть у игрока.
  • Сборка из исходников: gradlew build (Windows: gradlew.bat build), jar появится в build/libs/.
  • При первом запуске мод создаст папку scriptcraft/ и скопирует туда примеры скриптов и ресурсов.
  • Requires Minecraft 1.20.1 and Forge 47.x (Java 17).
  • Put scriptcraft-<version>.jar into the mods folder of the server and every client: screens, custom blocks and texture sync only work when the player has the mod.
  • Build from source: gradlew build (Windows: gradlew.bat build), the jar lands in build/libs/.
  • On first start the mod creates the scriptcraft/ folder and copies example scripts and resources into it.

2. Папка scriptcraft/2. The scriptcraft/ folder

Всё, что относится к моду, лежит в одной папке рядом с mods (на сервере — рядом с server.properties):

Everything the mod uses lives in one folder next to mods (on a server — next to server.properties):

scriptcraft/
  config.toml              (настройки / settings)
  scripts/                 (*.sc, UTF-8; подпапки читаются; "-имя.sc" — выключен)
    welcome.sc
    menu.sc
    ruby.sc
    -hud.sc                (пример HUD, выключен / disabled: /sc enable hud)
  variables/
    variables.json         (постоянные переменные / persistent variables)
  resources/
    assets/<namespace>/...   (текстуры, модели, lang — сервер отправит игрокам)
    data/<namespace>/...     (лут, теги, рецепты — только сервер)
  cache/assets/...         (клиент: ресурсы, полученные с серверов)

3. Первый скрипт3. Your first script

Создайте файл scriptcraft/scripts/hello.sc (кодировка UTF-8, отступ — Tab) и выполните в игре /sc reload hello:

Create scriptcraft/scripts/hello.sc (UTF-8, indent with Tab) and run /sc reload hello in game:

on join:
	send "&aПривет, %player%!" to player

command /hello:
	send "&bHello, %player%! Ты написал: %args%" to player
	play sound entity.experience_orb.pickup to player

Ошибки в скрипте (с номером строки) попадают прямо в редактор студии (F3 + `) и в лог сервера. Весь синтаксис — на вкладке Документация, готовые скрипты — в Примерах.

Script errors (with line numbers) show directly inside the studio editor (F3 + `) and the server log. All syntax is on the Docs tab, complete scripts are in Examples.

4. Команды мода4. Mod commands

/scriptcraft, /sc и /script — одно и то же. Нужен уровень оператора 2. Имена скриптов дополняются по Tab, .sc можно не писать.

/scriptcraft, /sc and /script are the same command. Operator level 2 is required. Script names tab-complete, .sc is optional.

КомандаCommandЧто делаетWhat it does
/sc helpсправкаhelp
F3 + `студия (главная, журнал, редактор с сайдбаром, автодополнением, поиском и заменой, совместной правкой)studio (home, journal, editor with sidebar, autocomplete, find & replace, and live collab)
/sc reloadперечитать конфиг, ресурсы и все скриптыreread the config, resources and every script
/sc reload configтолько config.toml (также применяется автоматически при правке файла)only config.toml (also auto-reloads when edited on disk)
/sc reload resourcesтолько scriptcraft/resourcesonly scriptcraft/resources
/sc reload <скрипт>перезагрузить один файл (подпапки: sub/name)reload one file (subfolders: sub/name)
/sc disable <скрипт>выключить: выгрузить и переименовать в -имя.scdisable: unload and rename to -name.sc
/sc enable <скрипт>включить обратно и загрузитьenable again and load
/sc listскрипты, команды, число переменных и ошибокscripts, commands, variable and error counts
/sc idsкакие id слотов получили блоки/предметы скриптовwhich slot ids script blocks/items got
/sc give <игроки> <id> [кол-во]выдать блок/предмет по id скриптаgive a script block/item by its id
Блоки и предметы: настоящие id + без перезапуска. define block/item, которые есть в скриптах при запуске, регистрируются под своими id (example:ruby_block). Новые после /sc reload появляются сразу во временных слотах scriptcraft:dyn_block_N / dyn_item_N, а после перезапуска переезжают на настоящие id. Blocks and items: real ids + no restart. define block/item present at startup get real ids (example:ruby_block). New ones after /sc reload appear immediately in temporary slots scriptcraft:dyn_block_N / dyn_item_N and move to real ids on restart.

5. Конфиг5. Config

Файл scriptcraft/config.toml создаётся при первом запуске и перечитывается автоматически при изменении на диске (или по /sc reload config) без перезапуска сервера. Описание каждого параметра — в разделе Конфиг.

scriptcraft/config.toml is created on first start and reloads automatically when edited on disk (or via /sc reload config) without restarting the server. Every option is described in the Config section.

[general]
    language = "en"
    enableTemporaryVariables = true
    variablesSaveIntervalSeconds = 300
    variableBackups = 5
    maxScriptSteps = 10000
    maxScriptMillis = 50
    logScriptLoadTimes = false
    allowCommandEffects = true
    targetedPlayerRange = 50

[resources]
    syncResourcesToClients = true
    maxResourceSizeMb = 32
    resourceChunkSizeKb = 256

[effectCommands]
    enableEffectCommands = true
    effectCommandToken = "?"
    effectCommandsRequireOp = true

[studio]
    liveEdit = false
    requireOp = true