Просмотр

== Описание 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
* dev-perl/Term-ReadPassword
* ogre
* ode
* ois
* openal

Кроме того, для некоторых важных модулей требуются библиотеки:
* libpcre >=6.6
* sqlite3
* wxGTK

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

Все программы и библиотеки, входящие в состав 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 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 rar] или [http://dao.deeptown.org/release/all/media.tar.bz2 tar.bz2]. Загрузите и распакуйте этот архив в любое удобное для Вас место на диске.

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

<!-- После того, как директория media распакована, нужно перейти в нее, скопировать файл config.dsh.sample в файл config.dsh, и отредактировать его в соответствии со своими нуждами. В файле приводятся подробные комментарии ко всем опциям. За более подробной информацией я опять же отсылаю Вас к соответствующей документации. -->

И самое последнее, что необходимо сделать — это определить три переменные среды, которые используются для поиска необходимых файлов:
* 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. Создаем /opt/deeptown и устанавливаем права:
sudo mkdir /opt/deeptown
sudo chown user:user /opt/deeptown

# 2. Устанавливаем dpmake
cd ~
wget http://dao.deeptown.org/release/all/dpmake.tbz2
tar -jxf dpmake.tbz2
cd dpmake
./build
make install

# 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

# 4. Устанавливаем необходимые пакеты
dpmake binpkg osa
dpmake binpkg bxl
dpmake binpkg dpkernel
dpmake binpkg gide
dpmake binpkg kpp_compiler

# 5. Распаковываем media
cd ~
mkdir -p deeptown/media
cd deeptown/media
wget http://dao.deeptown.org/release/all/media.rar
rar x media.rar

# 6. Используем
cd ~
echo 'export function main() { puts("Hello, world!\n"); }' > test.kpp
kpp -e test.kpp
</source>

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

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

На ОС Windows все гораздо проще: мы подготовили программу-инсталлятор, которая все сделает сама.

Ссылки на инсталляторы см. ниже.

Обращаем Ваше внимание на то, что при первом запуске требуется подождать некоторое время, пока идет индексация содержимого. При последующих запусках ждать будет не нужно.

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

=== Список дистрибутивов ===

Ниже приведен список дистрибутивов Deeptown SDK для Windows различных версий. Пожалуйста, указывайте версию дистрибутива в отчетах об ошибках.

* Последняя выпущенная версия:
** 22.09.2008: [http://dao.deeptown.org/release/windows-x86/deep-sdk-20080922.exe deep-sdk-20080922.exe]
* Более ранние версии:
** 15.08.2008: [http://dao.deeptown.org/release/windows-x86/deep-sdk-20080815.exe deep-sdk-20080815.exe]
** 16.07.2008: [http://dao.deeptown.org/release/windows-x86/deep-sdk-20080716.exe deep-sdk-20080716.exe]
** 19.06.2008: [http://dao.deeptown.org/release/windows-x86/deep-sdk-20080619.exe deep-sdk-20080619.exe]
** 12.05.2008: [http://dao.deeptown.org/release/windows-x86/deep_sdk_win32.exe deep_sdk_win32.exe]

== Что дальше? ==

'''Внимание: Информация в этом разделе устарела.'''

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