Скрипт

Материал из Ганджавики
Перейти к навигации Перейти к поиску

Сцена́рный язык (Скрипт) — высокоуровневый язык программирования для написания сценариев — кратких описаний действий, выполняемых системой. В ганджамире у большинства игроков скрипты являются неотъемлемой частью игры. В связи с этим администрация интегрировала GWPanel в игру. А 2 июля 2017 года панель была удалена из игры.

Сценарный язык — javascript-файл, который можно подключать к браузеру для обработки определенных страниц. Основная цель, с которой их внедряют в игру — косметические или функциональные доработки. Одни скрипты просто видоизменяют странички так, как многим игрокам хотелось бы, а другие — добавляют довольно серьезный функционал, которого нам так не хватает. В любом случае — скрипты делают процесс игры более комфортным.

Всё что требуется для использования скриптов в игре — добавить в браузер пользовательский скрипт GanjaScripts.user.js. После этого вы можете выбрать, подключить и/или настроить любой скрипт из каталога без скачивания дополнительных файлов.

На всякий случай напоминаю, что вы используете посторонние программы на свой страх и риск: игра существует в виде «как есть», и игровая механика не предусматривает и не поддерживает модифицирование функционала.

Ilia Sprite (adm)

Преимущества применения:
  • Не надо скачивать кучу разных файлов скриптов. Достаточно скачать только один скрипт — все остальные настройки по подключению скриптов предоставлены на сайте сервиса.
  • Для настройки скриптов не надо лезть в код скрипта. Вся настройка осуществляется на сайте.
  • Гарантия безопасности использования. Все поступающие скрипты становятся доступными для подключения только после проверки модераторами скриптов.
  • Привязка подключения скриптов и их настроек к персонажу в ГВ (используется кросс-серверная авторизация, привязанная к залогиненному у вас персонажу).
  • Один источник скриптов от разных авторов.
  • Более функциональные скрипты благодаря библиотеке функций, которые предоставляются разработчикам.
  • Единые стандарты оформления упростят подбор нужного вам скрипта.

Разработчикам

Если вы имеете опыт и желаете внести свою лепту, вам необходимо ознакомиться с информацией для разработчиков.

Преимущества

Есть ряд плюсов для разработчиков:

  • Единый разрекламированный ресурс для размещения своих творений — отпадает необходимость в оплате хостинга для сайта, выкладывании скриптов в фотоальбомах, информации персонажа.
  • Библиотека функций и регулярных выражений для работы с ГВ, которая сэкономит время написания и усилия.
  • Предоставление интерфейса для отправки сообщений в ICQ из скриптов
  • Лёгкое создание странички настройки скрипта.
  • Статистика количества пользователей ваших скриптов. (в стадии разработки)
  • Рейтинги скриптов и авторов (в стадии разработки)

Особенности JS кода

Основные отличия в оформлении скриптов для GanjaScripts от обычных пользовательских скриптов:

  • Весь скрипт должен быть оформлен внутри одной функции, которая будет точкой входа.
  • При сохранении скрипта используйте кодировку ANSI, а не UTF-8
  • В функцию-точку входа может передаваться один параметр с настройками скрипта. Но об этом ниже.
  • Не добавляйте проверку адреса странички. Если на странице, которую открыл пользователь ваш скрипт не должен работать — он не будет запрошен.

Правила для скриптов

Чтобы гарантировать игрокам безопасность, перед добавлением в каталог все скрипты проверяются модераторами скриптов. Для безболезненной проверки и гарантированного добавления скрипта, он должен соблюдать такие правила:

  • Скрипт не должен нарушать текущие Правила игры, в особенности касающийся пункта 3.3. Использования автоматических скриптов. Если вы не уверены — проконсультируйтесь с представителями синдиката  #1321 GW - Полиция.
  • Скрипт не должен вредить его пользователям (продавать вещи,выполнять рассылку писем, переводить деньги и другое без подтверждения пользователя).
  • С целью обезопасить пользователей от вредоносного кода старайтесь минимально использовать подключение скриптов или других данных со сторонних сайтов. Наиболее используемые js библиотеки будут размещены в списке скриптов.
  • Описания, названия скриптов не должны содержать нецензурные выражения.
  • Скрипт не должен передавать информацию о пользователе на сторонние ресурсы без упоминания об этом в описании скрипта.
  • Передавать на сторонние ресурсы или сторонним лицам закрытой информации пользователей строго запрещена и наказуема.

Пользователям

Установка скрипта:
  1. Скачиваете понравившийся скрипт.
  2. Открываете его в браузере, он предложит его установить. Для браузера Firefox необходим плагин Greasemonkey.

Скрипты можно открывать в любом текстовом редакторе (например в блокноте) и изменять.

Список скриптов

ScriptsPack

ScriptsPack (SP) — удобный сборник скриптов (модулей), который убирает большинство недостатков присущих как обычным раздельным скриптам, так и сборникам.

Используя SP у вас есть возможность настраивать все имеющиеся модули через удобный пользовательский интерфейс прямо на страничках игры, включать/выключать модули без необходимости использовать Greasemonkey или вообще в папку скриптов, импортировать/экспортировать настройки модулей, либо вообще всего SP, используя стандартный модуль Configurator, автоматически обновлять модули и загружать новые используя модуль Version Controller.

Особенность SP — необходимость загрузки всего одного файла, но не файла-сборника со всем абсолютно модулями, а только с 5-ю основными (системными). Все остальные модули подгружаются по вашему желанию всего один раз и сохраняются внутри браузера не требуя работы с файлами. Таким образом получаете компромисс между монолитным блоком и отдельно установленными скриптами.

Преимущества

  • Для установки вам нужен всего один файл.
  • Гибкость подгрузки модулей, то есть вы получаете только то, что вам действительно нужно, а не абсолютно всё что есть.
  • Функция импорта/экспорта настроек как отдельных модулей, так и всего SP, что позволяет вам без особых трудностей и лишних телодвижений переносить настроенный SP с одного компьютера на другой или делиться с друзьями оптимальными настройками.
  • Настройка скриптов прямо из игры с помощью удобного и понятного интерфейса с подробным описанием всех настроек, вместо обычного ковыряния в коде.
  • Встроенная поддержка файлов справки для модулей с описанием и инструкцией.
  • Автоматическое обновление модулей, даже без вашего участия (настраиваемо).
  • Возможность получать уведомления только о новых модулях или обновлениях, которые помечены как стабильные релизы (игнорируя ночные сборки и бета-версии).
  • Широкие возможности для модулей, лёгкая расширяемость, красивый и удобный интерфейс.

Совместимость

  • Opera 10.50+
  • Firefox 3.6+

Модули

Системные:

Основа SP — один единственный файл, в котором содержатся 5 системных модулей, которые обязательны для функционирования:

  • Tools — модуль для реализации служебных функций и упрощения работы.
  • Version Controller — управление версиями модулей, обновления, установка новых модулей.
  • ScriptsPack Loader — модуль для реализации служебных функций загрузки и исполнения всех остальных модулей.
  • Menu bar — отображение главного меню SP с системными кнопками и кнопками модулей.
  • Configurator — настройка, включение/выключение, удаление модулей, импорт/экспорт настроек.

Также, к системным модулям можно отнести скины, которые необходимы для работы, но догружаются при первом запуске, или по желанию пользователя.