Шаблон: оформление скрипта
Введение:
Еще один шаблон оформления, возможно, самый спорный. Жду ваших комментариев, если что-то непонятно или необходимо обязательно добавить.
Шаблон:
===================================================================================
Название вашего скрипта
Информация:
Автор: ник/имя автора скрипта
Переводчик: ник/имя переводчика, если вы переводите скрипт от иностранного разработчика
Готовность перевода: добавьте эту строку только если перевод еще не закончен
Ссылка на оригинал: опять же, если вы переводите чужой скрипт, будьте добры оставить ссылку на оригинал.
Версия скрипта: если ваш скрипт разработан не сразу и/или будет дорабатываться.
Версия мейкера: укажите, для какой версии мейкера создан этот скрипт.
Тип: допустим, Измененная система меню или Компонент, дополняющий систему
Условия использования/Лицензия: если вы/автор оригинального скрипта решили распространять скрипт под защитой какой-либо лицензии, укажите ее. Если же нет - просто удалите эту строку.
Описание:
Здесь вы поясняете кратко что это за скрипт и зачем он нужен. Также здесь желательно написать все зависимости: например, если это аддон к боевой системе, допустим, YanFly, то вам нужно указать, что требуется также YEA - Ace Battle Engine такой-то версии (в данном случае - не ниже 1.0).
Особенности:
Запишите здесь все особенности вашего скрипта и что он добавляет/как работает в виде списка, например:
добавляет дополнительное форматирование текста в сообщениях
позволяет посмотреть полученные квесты
позволяет наложить на персонажа статус при использовании вещи
Установка:
Необязательный пункт. Если для вашего скрипта не требуется особых Правил установки, а можно лишь вставить его над Main, то можете не писать этот пункт.
Зависимости:
Если код имеет зависимости (читай об этом в разделе "Введение"), то необходимо разместить здесь все скрипты, которые требует ля своей работы ваш.
Оформление:#======================
# YEA - Ace Battle Engine v1.00
#======================
# туча-туча кода
Примечание: первая строка кода обязательно должна быть написана без пробела от тега [ code type=ruby]!!!
Код:#Здесь должен быть ваш скрипт
Скриншоты:
Если скрипт каким-либо образом влияет на то, как будет выглядеть игра/меню/бои после его установки, желательно приложить хотя бы один скриншот. Максимальные размеры скриншота: 480х320, вес не более 500 КБ.
Бесплатные хостинги, генерирующие BB-код для вставки на форум:
hostingkartinok.com
pikucha.ru
radikal.cc
imageshack.us
И еще многие другие
Справочные материалы:
Необязательный пункт. Если к скрипту прилагается какая-то отдельная справка в формате PDF или CHM, поместите ссылку на ее скачивание сюда (см. заметку об оформлении ссылок ниже).
Скачать:
В этом разделе вы можете оставить сслку на скачивание скрипта или проекта с демонстрацией его возможностей.
Заметка про оформление ссылок:
Оформленный текст: | Для чего используется: |
Архив ZIP (Размер КБ/МБ) | для архивов в формате *.zip,*.rar,*.7z. Если ваш архив имеет формат RAR, то вы пишете "Архив RAR (100 МБ)". Размер вы можете посмотреть на своем компьютере, открыв свойства файла или же на хосте, на который вы только что загрузили файл. |
Видео на Youtube.com | Вы можете оставить ссылку на видео на youtube.com или любом другом сайте с онлайн-просмотром видео, демонстрирующим работу, описанную в вашей статье. Это не отменяет грамотного написания текста статьи. Текстовая статья обязательна! |
Документ DOCX (Размер КБ/МБ) | для документов в формате *.doc, *.docx, *.txt, *.odt, *.pdf, *.chm. Если ваш документ имеет формат ODT, то вы пишете, к примеру: "Документ ODT (81 КБ)". Этим документом может быть справочник по скрипту и его настройке (если он достаточно массивный и имеет множество возможностей для настройки). |
Сценарий RB (Размер КБ/МБ) | для текстовых файлов в формате *.rb с кодировкой utf-8. Обычно в них записаны скрипты, которые можно скопировать и вставить в редактор скриптов в RPG Maker. |
Сайт НАЗВАНИЕ САЙТА | Если вы хотите поместить ссылку на внешний источник, вам необходимо написать название сайта (и только его), например, "Сайт YANDEX.RU", чтобы пользователи сразу могли понять, куда они перейдут по ссылке. При этом необходимо указать только название сайта, а не всю ссылку целиком. |
Вы можете удалить эту заметку, если правильно оформили ссылки.
Благодарности:
Необязательный раздел. Если вам нечего здесь написать, вы можете просто удалить его.
===================================================================================
Примечание к оформлению разделов:
По просьбе пользователей хочу пояснить еще один момент:
Вместо названия раздела типа "Скачать" или "Информация" вы можете поставить картинки с этим текстом. Текст должен быть написан разборчивым шрифтом и картинка должна иметь размеры не более 480х160. Вы можете воспользоваться любым графическим редактором или же онлайн-конструктором: Сайт COOLTEXT.COM. Все разделы должны быть подписаны в едином стиле, одним шрифтом. Допустимо использование разных цветов для контура текста для каждого раздела.
Скачать шаблон:
Скачать шаблон вы можете по этой ссылке:
Документ TXT (6,65 КБ)