docs up

2011-02-28 09:04:59 +00:00 · 2011-02-28 09:04:59 +00:00 · 43ffda7be2
parent 85820503ba
commit 43ffda7be2
14 changed files with 615 additions and 0 deletions
--- a/doc/Makefile
+++ b/doc/Makefile
@ -15,12 +15,27 @@ wiki:
 	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:documentation&do=export_raw" -O writing_games.txt
 	wget "http://instead.syscall.ru/wiki/doku.php?id=en:gamedev:documentation&do=export_raw" -O writing_games-en.txt

+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:click&do=export_raw" -O modules/click.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:format&do=export_raw" -O modules/format.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:hideinv&do=export_raw" -O modules/hideinv.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:prefs&do=export_raw" -O modules/prefs.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:timer&do=export_raw" -O modules/timer.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:xact&do=export_raw" -O modules/xact.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:dash&do=export_raw" -O modules/dash.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:dbg&do=export_raw" -O modules/dbg.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:hoykeys&do=export_raw" -O modules/hotkeys.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:para&do=export_raw" -O modules/para.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:quotes&do=export_raw" -O modules/quotes.txt
+	wget "http://instead.syscall.ru/wiki/doku.php?id=ru:gamedev:modules:theme&do=export_raw" -O modules/theme.txt
+

 clean:
 all:
 install:
 	$(INSTALLD) $(DOCPATH)
 	$(INSTALL) *.html *.txt *.pdf $(DOCPATH)
+	$(INSTALLD) $(DOCPATH)/modules
+	$(INSTALL) modules/*.txt $(DOCPATH)/modules
 	$(INSTALLD) $(MANPATH)
 	$(INSTALL) *.6 $(MANPATH)

--- a/doc/Makefile.windows
+++ b/doc/Makefile.windows
@ -2,6 +2,8 @@ clean:
 all:
 install:
 	if not exist ..\bin\doc mkdir ..\bin\doc
+	if not exist ..\bin\doc\modules mkdir ..\bin\doc\modules
 	copy /Y *.txt ..\bin\doc
 	copy /Y *.html ..\bin\doc
 	copy /Y *.pdf ..\bin\doc
+	copy /Y modules\*.txt ..\bin\doc\modules
--- a/doc/modules/click.txt
+++ b/doc/modules/click.txt
@ -0,0 +1,31 @@
+====== Модуль Click ======
+
+^ Подключение          | require %%"%%click%%"%%         |
+^ Тип                  | расширение кода      |
+^ Зависимости          | нет                     |
+
+===== Описание =====
+
+Модуль позволяет удобным способом отслеживать клики мышкой по картинке сцены.
+При этом, во время клика будет вызван обработчик click текущей сцены, или
+одноименный обработчик game.click. В параметрах передаются координаты клика (x, y)
+в системе координат оригинального (немасштабированного) изображения. Координата 0,0 соответствует
+верхнему левому углу.
+
+===== Примеры использования =====
+<code lua>
+game.click = function(s, x, y)
+    p ("Click at:",x,",", y);
+end
+
+house = room {
+    nam = 'Дом';
+    pic = 'house.png';
+    click = function(s, x, y)
+        if x > 100 and x < 120 and y > 50 and y < 90 then
+            goto 'street'
+        end
+    end
+--    ...
+}
+</code>
--- a/doc/modules/dash.txt
+++ b/doc/modules/dash.txt
@ -0,0 +1,19 @@
+====== Модуль Dash ======
+
+^ Подключение          | require %%"%%dash%%"%%        |
+^ Тип                  | игровой         |
+^ Зависимости          | [[Format]]                     |
+
+===== Описание =====
+
+Заменяет последовательность символов %%--%% на символ --. Замена происходит //только//
+при выводе содержимого сцены.
+
+===== Примеры использования =====
+<code lua>
+require "dash"
+main = room {
+    nam = 'Введение';
+    dsc = [[ -- Ну, начнем!!!]];
+}
+</code>
--- a/doc/modules/dbg.txt
+++ b/doc/modules/dbg.txt
@ -0,0 +1,19 @@
+====== Модуль Dbg ======
+
+^ Подключение          | require %%"%%dbg%%"%%        |
+^ Тип                  | игровой      |
+^ Зависимости          | [[input]]                  |
+
+===== Описание =====
+Включает отладчик. Отладчик позволяет:
+  * переходить в разные локации;
+  * брать и выбрасывать предметы;
+  * выполнять lua код;
+  * делать дамп состояния объектов;
+
+===== Примеры использования =====
+
+После включения модуля в вашу игру, кликните на объект debug в инвентаре, 
+или нажмите клавишу "F7".
+
+
--- a/doc/modules/format.txt
+++ b/doc/modules/format.txt
@ -0,0 +1,18 @@
+====== Модуль Format ======
+
+^ Подключение          | require %%"%%format%%"%%        |
+^ Тип                  | расширение кода         |
+^ Зависимости          | нет                     |
+
+===== Описание =====
+Модуль format выполняет форматирование вывода. По умолчанию все настройки выключены:
+
+===== Примеры использования =====
+<code lua>
+format.para = false -- отступы в начале абзаца;
+format.dash = false -- замена двойного - на тире;
+format.quotes = false -- замена " " на << >>;
+format.filter = nil -- пользовательская функция замены;
+</code>
+
+Вы можете пользоваться модулями [[ru:gamedev:modules:para|para]], [[ru:gamedev:modules:dash|dash]], [[ru:gamedev:modules:quotes|quotes]] для включения отдельных настроек.
--- a/doc/modules/hideinv.txt
+++ b/doc/modules/hideinv.txt
@ -0,0 +1,28 @@
+====== Модуль Hideinv ======
+
+^ Подключение          | require %%"%%hideinv%%"%%       |
+^ Тип                  | расширение кода |
+^ Зависимости          | нет                     |
+
+===== Описание =====
+
+Модуль Hideinv позволяет временно выключать объекты в инвентаре для выбранных комнат.
+
+===== Примеры использования =====
+
+При определении комнаты, просто задайте аттрибут hideinv, например:
+<code lua>
+require "hideinv"
+
+happyend = room {
+    nam = 'Конец';
+    hideinv = true;
+    dsc = [[ Вы прошли игру! ]];
+}
+</code>
+
+
+===== Особенности =====
+
+Если ваша игра использует модуль [[xAct]] и вы хотите использовать свойство hideinv в xroom,
+включите модуль Hideinv раньше модуля [[xAct]].
--- a/doc/modules/hotkeys.txt
+++ b/doc/modules/hotkeys.txt
@ -0,0 +1,231 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ru" lang="ru" dir="ltr">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>ru:gamedev:modules:hoykeys - instead-wiki</title>
+<meta name="generator" content="DokuWiki" />
+<meta name="robots" content="noindex,follow" />
+<meta name="date" content="1970-01-01T03:00:00+0300" />
+<meta name="keywords" content="ru,gamedev,modules,hoykeys" />
+<link rel="search" type="application/opensearchdescription+xml" href="/wiki/lib/exe/opensearch.php" title="instead-wiki" />
+<link rel="start" href="/wiki/" />
+<link rel="contents" href="/wiki/ru/gamedev/modules/hoykeys?do=index" title="Все страницы" />
+<link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/wiki/feed.php" />
+<link rel="alternate" type="application/rss+xml" title="Current Namespace" href="/wiki/feed.php?mode=list&amp;ns=ru:gamedev:modules" />
+<link rel="alternate" type="text/html" title="Plain HTML" href="/wiki/_export/xhtml/ru/gamedev/modules/hoykeys" />
+<link rel="alternate" type="text/plain" title="Wiki Markup" href="/wiki/_export/raw/ru/gamedev/modules/hoykeys" />
+<link rel="stylesheet" media="screen" type="text/css" href="/wiki/lib/exe/css.php?t=vector&amp;tseed=1292527528" />
+<link rel="stylesheet" media="all" type="text/css" href="/wiki/lib/exe/css.php?s=all&amp;t=vector&amp;tseed=1292527528" />
+<link rel="stylesheet" media="print" type="text/css" href="/wiki/lib/exe/css.php?s=print&amp;t=vector&amp;tseed=1292527528" />
+<script type="text/javascript" ><!--//--><![CDATA[//><!--
+var NS='ru:gamedev:modules';var JSINFO = {"id":"ru:gamedev:modules:hoykeys","namespace":"ru:gamedev:modules"};
+//--><!]]></script>
+<script type="text/javascript" charset="utf-8" src="/wiki/lib/exe/js.php?tseed=1292527528" ></script>
+
+<link rel="shortcut icon" href="/wiki/lib/tpl/vector/static/3rd/dokuwiki/favicon.ico" />
+<!--[if lt IE 7]><style type="text/css">body{behavior:url("/wiki/lib/tpl/vector/static/3rd/vector/csshover.htc")}</style><![endif]-->
+</head>
+<body class="skin-vector">
+<div id="page-base" class="noprint"></div>
+<div id="head-base" class="noprint"></div>
+
+<!-- start div id=content -->
+<div id="content">
+  <a name="top" id="top"></a>
+  <a name="dokuwiki__top" id="dokuwiki__top"></a>
+
+  <!-- start main content area -->
+  
+  <!-- start div id bodyContent -->
+  <div id="bodyContent" class="dokuwiki">
+    <!-- start rendered wiki content -->
+    
+<h1 class="sectionedit1"><a name="эта_страница_ещё_не_существует" id="эта_страница_ещё_не_существует">Эта страница ещё не существует</a></h1>
+<div class="level1">
+
+<p>
+
+Вы перешли по ссылке на тему, для которой ещё не создана страница. Если позволяют ваши права доступа, вы можете создать её, нажав на кнопку «Создать страницу».
+</p>
+
+</div>
+
+<!-- cachefile /home/users2/g/gl00my/domains/instead.syscall.ru/wiki/data/cache/2/2fa954054b6a204dc9178ba2b5d62b4d.xhtml used -->
+
+    <!-- end rendered wiki content -->
+    <div class="clearer"></div>
+  </div>
+  <!-- end div id bodyContent -->
+
+  
+</div>
+<!-- end div id=content -->
+
+
+<!-- start div id=head -->
+<div id="head" class="noprint">
+  
+  <div id="p-personal">
+    <ul>
+      <li id="pt-login"><a href="/wiki/ru/gamedev/modules/hoykeys?do=login" rel="nofollow">Войти</a></li>
+    </ul>
+  </div>
+
+  <!-- start div id=left-navigation -->
+  <div id="left-navigation">
+    <div id="p-namespaces" class="vectorTabs">
+      <ul>
+        <li id="ca-nstab-main" class="selected"><a href="/wiki/ru/gamedev/modules/hoykeys"><span>Статья</span></a></li>
+        <li id="ca-talk"><a href="/wiki/talk/ru/gamedev/modules/hoykeys"><span>Обсуждение</span></a></li>
+      </ul>
+    </div>
+  </div>
+  <!-- end div id=left-navigation -->
+
+  <!-- start div id=right-navigation -->
+  <div id="right-navigation">
+    <div id="p-views" class="vectorTabs">
+      <ul>
+        <li id="ca-edit"><a href="/wiki/ru/gamedev/modules/hoykeys?do=edit&amp;rev=0" accesskey="E" title="[ALT+E]"><span>Показать исходный текст</span></a></li>
+      </ul>
+    </div>
+    <div id="p-search">
+      <h5>
+        <label for="qsearch__in">Поиск</label>
+      </h5>
+      <form action="/wiki/" accept-charset="utf-8" id="dw__search" name="dw__search">
+        <input type="hidden" name="do" value="search" />
+        <div id="simpleSearch">
+          <input id="qsearch__in" name="id" type="text" accesskey="f" value="" />
+          <button id="searchButton" type="submit" name="button" title="Искать следующий текст:">&nbsp;</button>
+        </div>
+        <div id="qsearch__out" class="ajax_qsearch JSpopup"></div>
+      </form>
+    </div>
+  </div>
+  <!-- end div id=right-navigation -->
+
+</div>
+<!-- end div id=head -->
+
+<!-- start panel/sidebar -->
+<div id="panel" class="noprint">
+  <!-- start logo -->
+  <div id="p-logo">
+      <a href="/wiki/" style="background-image:url(/wiki/lib/tpl/vector/static/3rd/dokuwiki/logo.png);" accesskey="h" title="[ALT+H]"></a>
+  </div>
+  <!-- end logo -->
+
+  
+  <div id="p-navigation" class="portal">
+    <h5>Навигация</h5>
+    <div class="body">
+      <div class="dokuwiki">
+
+<p>
+<a href="/wiki/ru/start" class="wikilink1" title="ru:start">Главная страница</a>
+</p>
+
+<p>
+<a href="/wiki/ru/install" class="wikilink1" title="ru:install">Установка</a>
+</p>
+
+<p>
+<a href="/wiki/ru/games" class="wikilink1" title="ru:games">Игры</a>
+</p>
+
+<p>
+<a href="/wiki/ru/gamedev" class="wikilink1" title="ru:gamedev">Разработка игр</a>
+</p>
+
+<p>
+<a href="/wiki/ru/useful" class="wikilink1" title="ru:useful">Дополнительно</a>
+</p>
+
+<p>
+<a href="/wiki/ru/help" class="wikilink1" title="ru:help">Помощь</a>
+</p>
+
+<!-- cachefile /home/users2/g/gl00my/domains/instead.syscall.ru/wiki/data/cache/e/eb675e6ee08628bc0128cf47d3efee8d.xhtml used -->
+
+      </div>
+    </div>
+  </div>
+  <div id="p-coll-print_export" class="portal">
+    <h5>Печать, экспорт</h5>
+    <div class="body">
+      <div class="dokuwiki">
+      <ul>
+        <li id="t-print"><a href="/wiki/ru/gamedev/modules/hoykeys?rev=0&amp;vecdo=print" rel="nofollow">Версия для печати</a></li>
+      </ul>
+      </div>
+    </div>
+  </div>
+  <div id="p-lang" class="portal">
+    <h5>Язык</h5>
+    <div class="body">
+      <div class="dokuwiki">
+<div class="plugin_translation"><span>Перевод этой страницы:</span> <ul>  <li><div class="li"><a href="/wiki/en/gamedev/modules/hoykeys" class="wikilink2" title="English">en</a></div></li>  <li><div class="li"><a href="/wiki/es/gamedev/modules/hoykeys" class="wikilink2" title="español">es</a></div></li>  <li><div class="li"><a href="/wiki/ru/gamedev/modules/hoykeys" class="wikilink2" title="Русский">ru</a></div></li></ul></div>
+      </div>
+    </div>
+  </div>
+  <div id="example4" class="portal">
+    <h5>Инструменты</h5>
+    <div class="body">
+      <div class="dokuwiki">
+<ul>
+  <li><a href="/wiki/ru/gamedev/modules/hoykeys?do=backlink" rel="nofollow">Ссылки сюда</a></li>
+<li id="t-recentchanges"><a href="/wiki/?do=recent" rel="nofollow">Свежие правки</a></li>
+<li id="t-upload"><a href="/wiki/lib/exe/mediamanager.php?ns=ru:gamedev:modules" rel="nofollow">Загрузить файл</a></li>
+<li id="t-special"><a href="/wiki/?do=index" rel="nofollow">Все страницы</a></li>
+<li id="t-permanent"><a href="/wiki/ru/gamedev/modules/hoykeys?rev=0" rel="nofollow">Постоянная ссылка</a></li>
+</ul>
+      </div>
+    </div>
+  </div>
+  <div id="example2" class="portal">
+    <h5>Ссылки</h5>
+    <div class="body">
+      <div class="dokuwiki">
+<ul>
+  <li><a href="http://instead.syscall.ru/">Сайт INSTEAD</a></li>
+  <li><a href="http://code.google.com/p/instead/">Репозиторий на Google code</a></li>
+  <li><a href="http://instead.syscall.ru/forum/">Форум</a></li>
+  <li><a href="http://instead.syscall.ru/wiki/ru/links">Материалы по теме</a></li>
+  <li><a href="http://instead.syscall.ru/wiki/ru/credits">Участники проекта</a></li>
+  <li><a href="http://instead.syscall.ru/wiki/ru/changelog">История версий</a></li>
+</ul>
+      </div>
+    </div>
+  </div>
+
+
+</div>
+<!-- end panel/sidebar -->
+
+<!-- start footer -->
+<div id="footer">
+  <ul id="footer-info">
+    <li id="footer-info-lastmod">
+      <br />
+    </li>
+    <li id="footer-info-copyright">
+      <div class="dokuwiki"><div class="license">За исключением случаев, когда указано иное, содержимое этой вики предоставляется на условиях следующей лицензии:<a href="http://creativecommons.org/licenses/by-nc-sa/3.0/" rel="license" class="urlextern">CC Attribution-Noncommercial-Share Alike 3.0 Unported</a></div></div>
+    </li>
+  </ul>
+  <ul id="footer-places" class="noprint">
+    <li>
+      <a href="/wiki/feed.php" rel="nofollow" title="Свежие правки" target="_blank"><img src="/wiki/lib/tpl/vector/static/img/button-rss.png" width="80" height="15" title="Свежие правки" alt="Свежие правки" border="0" /></a>
+      <a href="http://andreas-haerter.com/donate/vector/paypal" rel="nofollow" title="Пожертвовать" target="_blank"><img src="/wiki/lib/tpl/vector/static/img/button-donate.gif" width="80" height="15" title="Пожертвовать" alt="Пожертвовать" border="0" /></a>
+      <a href="http://andreas-haerter.com/projects/dokuwiki-template-vector" title="шаблон vector для DokuWiki" target="_blank"><img src="/wiki/lib/tpl/vector/static/img/button-vector.png" width="80" height="15" title="шаблон vector для DokuWiki" alt="шаблон vector для DokuWiki" border="0" /></a>
+      <a href="http://www.dokuwiki.org" title="DokuWiki" target="_blank"><img src="/wiki/lib/tpl/vector/static/img/button-dw.png" width="80" height="15" title="DokuWiki" alt="DokuWiki" border="0" /></a>
+      <a href="http://validator.w3.org/check/referer" rel="nofollow" title="Valid XHTML" target="_blank"><img src="/wiki/lib/tpl/vector/user/button-xhtml.png" width="80" height="15" title="Valid XHTML" alt="Valid XHTML" border="0" /></a>
+    </li>
+  </ul>
+  <div style="clearer"></div>
+</div>
+<!-- end footer -->
+
+</body>
+</html>
--- a/doc/modules/para.txt
+++ b/doc/modules/para.txt
@ -0,0 +1,19 @@
+====== Модуль Para ======
+
+^ Подключение          | require %%"%%para%%"%%        |
+^ Тип                  | игровой |
+^ Зависимости          | [[Format]]                     |
+
+===== Описание =====
+
+Ставит отступ в начале каждого параграфа в соответствии с русской типографской традицией. Дополнение отступом производится //только// при выводе содержимого сцены.
+
+Вы можете менять количество пробелов в отступе с помощью задания format.para_space:
+
+<code lua>
+format.para_space = "        ";
+</code>
+
+
+
+
--- a/doc/modules/prefs.txt
+++ b/doc/modules/prefs.txt
@ -0,0 +1,37 @@
+====== Модуль Prefs  ======
+
+^ Подключение          | require %%"%%prefs%%"%%        |
+^ Тип                  | расширение кода |
+^ Зависимости          | нет                     |
+
+===== Описание =====
+Этот модуль позволяет сохранять настройки игры. Другими словами, сохраненная информация не зависит от состояния игры.
+Такой механизм можно использовать, например, для реализации системы достижений или счетчика количества прохождений игры.
+
+prefs это объект, все переменные которого буду сохранены.
+
+prefs:store() -- сохранить настройки.
+
+prefs:purge() -- удалить все настройки.
+
+Загрузка настроек выполняется автоматически при инициализации игры (перед вызовом функции init()), но вы можете инициировать загрузку и вручную:
+
+prefs:load();
+
+===== Примеры использования =====
+<code lua>
+instead_version "1.3.0"
+require "click"
+require "prefs"
+
+prefs.counter = 0
+
+game.click = function(s)
+    prefs.counter = prefs.counter + 1
+    prefs:store();
+    p("Кликов:", prefs.counter);
+end
+
+game.pic = 'clickme.png'
+-- ...
+</code>
--- a/doc/modules/quotes.txt
+++ b/doc/modules/quotes.txt
@ -0,0 +1,34 @@
+====== Модуль Quotes ======
+
+^ Подключение          | require %%"%%quotes%%"%%        |
+^ Тип                  | игровой |
+^ Зависимости          | [[Format]]                     |
+
+===== Описание =====
+
+Заменяет все двойные кавычки на типографские ("ёлочки").
+
+Также заменяет ,, (две запятые) и %%''%% (два апострофа) на кавычки-"лапки" („”).
+
+Замена происходит //только// при выводе содержимого сцены.
+
+Рекомендуется к применению для соответствия русской типографской традиции. Напомним, что обычно используются "ёлочки", но для употребления кавычек в кавычках и для передачи прямой речи следует использовать "лапки".
+
+===== Примеры использования =====
+<code>
+"Текст в елочках"
+</code>
+
+Результат: «текст в елочках».
+<code>
+,,Текст в лапках''.
+</code>
+
+Результат: „текст в лапках“.
+
+<code>
+_"Текст в елочках _"вложенный"_
+</code>
+
+Результат: «текст в елочках «вложенный».
+
--- a/doc/modules/theme.txt
+++ b/doc/modules/theme.txt
@ -0,0 +1,60 @@
+====== Модуль Theme ======
+
+^ Подключение          | require "theme"        |
+^ Тип                  | игровой |
+^ Зависимости          | нет                     |
+
+===== Описание =====
+Начиная с версии 1.3.0, модуль theme позволяет модифицировать параметры темы на лету.
+Для этого, используются следующие функции:
+<code lua>
+-- настройка окна вывода
+win.geom(x, y, w, h)
+win.color(fg, link, alink)
+win.font(name, size, height)
+win.gfx.up(pic, x, y)
+win.gfx.down(pic, x, y)
+
+-- настройка инвентаря
+inv.geom(x, y, w, h)
+inv.color(fg, link, alink)
+inv.font(name, size, height)
+inv.gfx.up(pic, x, y)
+inv.gfx.down(pic, x, y)
+inv.mode(mode)
+
+-- настройка меню
+menu.bw(w)
+menu.color(fg, link, alink)
+menu.font(name, size, height)
+menu.gfx.button(pic, x, y)
+	
+-- настройка графики
+gfx.cursor(norm, use, x, y)
+gfx.mode(mode)
+gfx.pad(pad)
+gfx.bg(bg)
+
+-- настройка звука
+snd.click(name);
+</code>
+
+Если необходимо изменить только часть параметров, в качестве неизменяемых параметров можно указывать значение nil. Например:
+<code lua>
+win.font(nil, 64);
+</code>
+
+Существует возможность чтения текущих параметров тем:
+<code lua>
+theme.get 'имя переменной темы';
+</code>
+===== Примеры использования =====
+
+<code lua>
+gfx.bg "dramatic_bg.png";
+win.geom (0,0, theme.get 'scr.w', theme.get 'scr.h');
+inv.mode 'disabled'
+</code>
+
+
+
--- a/doc/modules/timer.txt
+++ b/doc/modules/timer.txt
@ -0,0 +1,43 @@
+====== Модуль Timer ======
+
+^ Подключение          | require %%"%%timer%%"%%         |
+^ Тип                  | расширение кода |
+^ Зависимости          | нет                     |
+
+===== Описание =====
+
+Модуль позволяет получать события от таймера удобным способом.
+Функцию обработчика таймера выполняет game.timer.
+Если game.timer возвращает пустое значение, 
+сцена не перерисовывается. В противном случае,
+возвращаемое значение интерпретируется как действие.
+
+Вы можете делать локальные для комнаты обработчики timer. Если
+в комнате объявлен обработчик timer, он вызовется вместо game.timer
+
+===== Примеры использования =====
+<code lua>
+game.timer = function(s)
+    set_sound('gfx/beep.ogg');
+    p "Timer:"
+    p (time())
+end
+function init()
+    timer:set(1000)
+end
+</code>
+
+<code lua>
+myroom = room  {
+    entered = function(s)
+        timer:set(1000);
+    end;
+    timer = function(s)
+        timer:stop();
+        goto 'myroom2';
+    end;
+    nam = 'Проверка таймера';
+    dsc = [[Ждите.]];
+}
+</code>
+
--- a/doc/modules/xact.txt
+++ b/doc/modules/xact.txt
@ -0,0 +1,59 @@
+====== Модуль xAct ======
+
+^ Подключение          | require %%"%%xact%%"%%        |
+^ Тип                  | расширение кода |
+^ Зависимости          | нет                     |
+
+===== Описание =====
+Модуль позволяет делать ссылки на объекты из других объектов, реакций и life методов в форме: {объект(параметры):текст}.
+
+Начиная с версии 1.2.2 (instead_version "1.2.2") символ разделителя задается stead.delim и по-умолчанию содержит '|'. То-есть формат записи выглядит так: {объект(параметры)|текст}.
+
+Где 'объект' это сам объект или атрибут nam объекта. При этом, чтобы ссылка работала, объект должен
+присутствовать в сцене.(Начиная с 1.2.2 -- не обязательно).
+
+(параметры) -- необязательные параметры в виде: (текст, текст, ...)
+
+'текст' -- то, как ссылка выглядит в игре для игрока.
+
+Модуль содержит в себе функцию xact, которая создает объект - простейшую реакцию.
+Первый параметр функции -- имя, второй -- реакция, которая может быть строкой, функцией или code.
+
+Модуль содержит в себе реализацию комнаты с расширенным описанием: xroom. Если в такой комнате задать
+атрибут xdsc, то он будет выведен в области описаний объектов.
+
+Функция xdsc позволяет более гибко управлять выводом текста в области предметов. См. примеры.
+===== Примеры использования =====
+<code lua>
+main = room {
+    forcedsc = true;
+    dsc = [[От автора. Эту игру я писал очень  {note1|долго}.]];
+    obj = {
+        xact('note1', [[Больше 10 лет.]]);
+    }
+}
+</code>
+
+<code lua>main = room {
+    forcedsc = true;
+    dsc = [[Я в комнате.]];
+    xdsc = [[ Я вижу {apple|яблоко} и {knife|нож}. ]];
+    other = [[ Еще здесь лежат {chain|цепь} и {tool|пила}.]];
+    obj = {
+        xdsc(), -- 'xdsc method by default'
+        xdsc 'other',
+        'apple', 'knife', 'chain', 'tool',
+    }
+}
+</code>
+
+<code lua>
+main = xroom {
+    forcedsc = true;
+    dsc = [[Я в комнате.]];
+    xdsc = [[ Я вижу {apple|яблоко} и {knife|нож}. ]];
+    obj = {
+        'apple', 'knife', 'chain', 'tool',
+    }
+}
+</code>