Deeptown SDK

Описание Deeptown SDK

Deeptown Software Development Kit — это набор программ, утилит и библиотек для разработки приложений для платформы Deeptown.

В публичном доступе выпускается бинарная версия SDK — т.е. набор библиотек и программ, скомпилированных для различных операционных систем. Исходные коды по прежнему остаются закрытыми; доступ к ним предоставляется только при необходимости и при подписании соответствующего соглашения о конфиденциальности. Если Вас это интересует — пишите.

Структура SDK

SDK поставляется в виде отдельных небольших пакетов. Для различных задач Вам может потребоваться только часть из них. В ближайшем будущем, на этой Wiki будет выложена подробная информация о существующих пакетах и их составе.

Установка SDK на POSIX-совместимых системах

Требования к системе

На данный момент из всех POSIX-совместимых систем Deeptown SDK поддерживает только ОС Linux. В ближайшем будущем планируется поддержка FreeBSD; остальные POSIX-системы мы не поддерживаем, т.к. это почти никому не требуется. Если Вам нужен дистрибутив для какой-то конкретной системы, Вы можете написать нам, и мы постараемся собрать дистрибутив для Вашей системы, если это будет возможно.

Для ядра системы требуются:

• gcc версии >=3.4 с модулем поддержки языка C++ (g++);
• make
• perl >= 5.0
• wget

Кроме того, для некоторых важных модулей требуются библиотеки:

• libpcre >=6.6
• sqlite3

Подготовка к установке

Все программы и библиотеки, входящие в состав Deeptown SDK, собраны для установки в директорию /opt/deeptown. Абсолютно все изменения в Вашей системе будут происходить именно в этой директории; больше ничего использоваться не будет. Это сделано специально - для удобства удаления и/или переустановки SDK.

Для удобства использования программ, добавьте путь /opt/deeptown/bin к пути поиска программ (переменная среды PATH). Если Вы используете bash, это можно сделать, добавив в $HOME/.bash_profile следующую строчку:

export PATH=/opt/deeptown/bin:$PATH

Кроме того, рекомендуется установить для себя права на запись в директорию /opt/deeptown, чтобы производить установку новых пакетов под обычным пользователем, а не под рутом. Просто создайте эту директорию вручную и измените ее владельца на свою рабочую учетную запись.

Установка dpmake

Наконец, переходим к процессу установки.

В первую очередь нужно вручную скачать и установить утилиту dpmake. Она предназначена для сборки библиотек на платформе Диптаун; она же служит простейшим менеджером пакетов Deeptown SDK.

Последняя версия dpmake находится по адресу http://dao.deeptown.org/release/all/dpmake.tbz2.

Скачав ее, наберите следующие команды:

tar -jxf dpmake.tbz2        # распаковываем архив
cd dpmake                   # переходим в директорию сборки
./build                     # настройка и компиляция
make install                # установка в /opt/deeptown

Последняя команда может потребовать привелегий суперпользователя, если Вы не последовали предыдущему совету разрешить себе права на запись в /opt/deeptown.

Чтобы убедиться, что Ваша система поддерживается, наберите команду

dpmake_config --platform

Эта команда выведет имя платформы, состоящее из названия ОС, архитектуры процессора и версии libc. На данный момент Deeptown SDK поддерживает следующие платформы:

• linux-i686-libc6
• linux-x86_64-libc6

Если предыдущая команда вывела одну из указанных в списке платформ - все нормально, Вы можете продолжать установку.

В противном случае, Вы можете попробовать одно из следующих действий:

• указать платформу вручную, передавая команде dpmake параметр --platform=имя_платформы_из_списка;
• Написать нам просьбу собрать Deeptown SDK для Вашей платформы. Мы постараемся сделать это как можно скорее; это не должно занять больше недели времени (в зависимости от занятости разработчиков).

Установка пакетов

Для установки пакетов служит команда

dpmake binpkg имя_пакета

Она автоматически загружает требуемый пакет с сервера и распаковывает его.

Полный список пакетов в настоящее время выглядит так:

• osa
• dptools
• bxl
• dpkernel
• deeptown
  • diss
  • gide
  • mein
  • network
  • security
  • servers
  • startup
  • stream
  • tinyftpd
  • utils
    • kpp_compiler
    • graphics_config
  • world

Примечание: Пакеты deeptown и utils являются т. н. метапакетами, содержащими все пакеты уровнем ниже. Таким образом, при установке пакета utils, будут установлены пакеты kpp_compiler и graphics_config; а при установке пакета deeptown — все пакеты от diss до world включительно.

Более подробно почитать о назначении пакетов можно здесь: Описание установочных пакетов.

Завершение установки

Наконец, для использования SDK, требуется выполнить следующие действия.

Прежде всего необходимо установить файлы данных, с которыми будут работать программы из SDK. Подробное описание этих файлов и их форматов можно найти в соответствующей документации.

Последнюю версию медиаданных всегда можно найти по адресу http://dao.deeptown.org/release/all/media.rar. Загрузите и распакуйте этот архив в любое удобное для Вас место на диске.

При этом необходимо учесть следующие моменты:

• программам будет требоваться доступ на запись в пределах этой директории;
• многое из того, что Вы будете создавать с использованием Deeptown SDK, будет сохраняться в рамках этой директории. Поэтому, когда загружаете новую версию media, не удаляйте старую, а распаковывайте файлы поверх предыдущих.

И самое последнее, что необходимо сделать — это определить три переменные среды, которые используются для поиска необходимых файлов:

• DEEPTOWN_LIBRARY = /opt/deeptown/lib — путь к плагинам;
• DEEPTOWN_MEDIA — путь к директории media, про которую шла речь выше;
• DEEPTOWN_CONFIG = /opt/deeptown/etc/deeptown — путь к файлам конфигурации.

Для того же bash соответствующие строки в .bash_profile будут выглядеть следующим образом:

export DEEPTOWN_LIBRARY="/opt/deeptown/lib"
export DEEPTOWN_CONFIG="/opt/deeptown/etc/deeptown"
export DEEPTOWN_MEDIA="/home/user/deeptown/media"   # замените на свой путь!

Быстрый старт использования компилятора K++

Текущий пользователь — user.

<source lang="bash">

1. 1. Создаем /opt/deeptown и устанавливаем права:

sudo mkdir /opt/deeptown sudo chown user:user /opt/deeptown

1. 2. Устанавливаем dpmake

cd ~ wget http://dao.deeptown.org/release/all/dpmake.tbz2 tar -jxf dpmake.tbz2 cd dpmake ./build make install

1. 3. Прописываем необходимые переменные среды

cd ~ echo 'export PATH="/opt/deeptown/bin:$PATH"' >> .bash_profile echo 'export DEEPTOWN_LIBRARY="/opt/deeptown/lib"' >> .bash_profile echo 'export DEEPTOWN_CONFIG="/opt/deeptown/etc/deeptown"' >> .bash_profile echo 'export DEEPTOWN_MEDIA="/home/user/deeptown/media"' >> .bash_profile . .bash_profile

1. 4. Устанавливаем необходимые пакеты

dpmake binpkg osa dpmake binpkg bxl dpmake binpkg dpkernel dpmake binpkg gide dpmake binpkg kpp_compiler

1. 5. Распаковываем media

cd ~ mkdir -p deeptown/media cd deeptown/media wget http://dao.deeptown.org/release/all/media.rar rar x media.rar

1. 6. Используем

cd ~ echo 'package test; export function main() { puts("Hello, world!\n"); }' > test.kpp kpp -e test.kpp </source>

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

Установка SDK на ОС Windows

Установка для ОС Windows, в настоящий момент, производится двумя вариантами: автоматически, при использовании инсталлятора, либо путем описанным ниже. Вторым вариантом так же стоит пользоваться в случае, если, по каким бы то ни было причинам, первым вариантом воспользоваться не получилось.

Первый вариант

Скачиваем дистриб deep_sdk_win32.exe, запускаем и устанавливаем. Внимательно читаем инструкции в установщике. Запускаем и ... в общем надо подождать 1-5 минут при первом запуске - это необходимо для индексирования наполнения. последующие запуски проходят без этой задержки.

Второй вариант

Первый шаг

Сначала необходимо скачать архив с бинарными файлами, который расположен по адресу http://dao.deeptown.org/release/windows-x86/sdk.rar и распаковать в удобную для вас директорию.

ВНИМАНИЕ: В настоящий момент существует проблема в реализации библиотеки OSA, которая требует, чтобы путь к директории установки не содержал пробелов и символов национальных кодировок. Это временная проблема, которую мы постараемся решить в скором будущем. Вот примеры правильных путей:

C:\deep\
D:\MyFolder\programs\deeptown_SDK\

А вот такие пути использовать НЕЛЬЗЯ:

C:\Program Files\Deeptown SDK
D:\Мои Программы\Разработка\deep

Мы рекомендуем устанавливать архив в директорию c:\deep.

Второй шаг

Скачайте архив с данными, расположенный по адресу http://dao.deeptown.org/release/all/media.rar и распакуйте его по адресу c:\deep\Media, изменив путь в соответствии с вашей директорией установки.

Если все прошло успешно, то можно попытаться запустить диптаун, выполнив файл c:\deep\deep.exe из командной строки либо через проводник.

Примечания

Обратите внимание, что устанавливаемый файл kpp.exe является консольной утилитой. Его нужно запускать из командной строки. Для получения списка возможных параметров, наберите kpp -h.

Что дальше?

Дальше, если все прошло успешно, вы можете обратиться к странице "с чего начать", где вкратце описано что и как можно делать.