Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/dev-deploy.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build docs
name: Build and deploy dev docs

on:
push:
Expand Down Expand Up @@ -29,7 +29,7 @@ jobs:
- name: Build static files
run: |
cd docs
make html
make html-all

- name: Upload build artifact
uses: actions/upload-artifact@v5.0.0
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/prod-deploy.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Build docs
name: Build and deploy prod docs

on:
push:
Expand Down Expand Up @@ -27,7 +27,7 @@ jobs:
- name: Build static files
run: |
cd docs
make html
make html-all

- name: Upload build artifact
uses: actions/upload-artifact@v5.0.0
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# joinrpg-docs

[![Documentation Status](https://readthedocs.org/projects/joinrpg/badge/?version=latest)](http://joinrpg.readthedocs.io/ru/latest/?badge=latest)
Linter warnings and errors:
Actions - Build sphinx docs job - Build static files step

In this repository we have documentation for joinrpg. See http://docs.joinrpg.ru.
Maintainers: @tsareva, @dtrub
11 changes: 11 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,17 @@ html:
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

.PHONY: html-old
html-old:
$(SPHINXBUILD) -b html -D html_baseurl='/ru/latest/' $(ALLSPHINXOPTS) $(BUILDDIR)/html/ru/latest
@echo
@echo "Old link style version for backward compatibility built in $(BUILDDIR)/html/ru/latest"

.PHONY: html-all
html-all: html html-old
@echo
@echo "Build finished. HTML pages available at / and /ru/latest"

.PHONY: dirhtml
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
Expand Down
10 changes: 5 additions & 5 deletions docs/accommodation/rooms_for_participants.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Расселение участников
=======================
=====================

Для того, чтобы определить проживание участников в конкретных комнатах с конкретными соседями, воспользуйтесь меню **Прочее > Настройки > Поселение > (иконка «расселение» у нужного типа комнаты)**

Expand All @@ -8,7 +8,7 @@
:align: center
:alt: Список комнат

.. attetion:: Проживание назначается для **человека**, а не для персонажа. В случае смены игрока на роли новому игроку потребуется назначить тип проживания заново.
.. attention:: Проживание назначается для **человека**, а не для персонажа. В случае смены игрока на роли новому игроку потребуется назначить тип проживания заново.

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

Expand All @@ -20,7 +20,7 @@
.. attention:: Список соседей со ссылкой на профиль joinrpg будет виден всем проживающим в этой комнате. Избегайте спойлеров для игроков!

Список участников для типа размещения
---------------------------------
-------------------------------------

На вкладке «Комнаты» типа размещения показываются все участники, в заявках которых указан этот тип. Сверху располагаются те, кто еще не приписан к конкретной комнате; те, чье проживание определено, расположены в ячейках соответствующих помещений. Каждая заявка сопровождается указанием, сколько из назначенной к оплате суммы (включая оргвзнос, цену за место проживания, другие выбранные опции) еще осталось оплатить.

Expand All @@ -31,7 +31,7 @@


Массовое заселение / выселение
---------------------------------
------------------------------

.. figure:: in_or_out.JPG
:scale: 100 %
Expand All @@ -46,7 +46,7 @@
Функция «Выселить всех» также доступна на странице со списком типов размещения. При ее использовании будут освобождены все комнаты всех типов разменения

Выбор проживающих для каждой комнаты
--------------------------------------
------------------------------------

.. figure:: in_for_room.JPG
:scale: 100 %
Expand Down
17 changes: 9 additions & 8 deletions docs/api/integration.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Интеграция ИТ систем
========================
====================

Данный документ призван обобщить опыт игр Deus Ex и Магеллан по тому, как удобно и правильно интегрировать бекенд вашей игры и joinrpg.
Предназначен для мастеров, у которых на игре есть некая ИТ-система, предоставляющая возможности в рамках игрового мира. В дальнейшем будем называть ее Система.

Привязка всего к персонажу
-----------------------
--------------------------
.. note:: Эти принципы мы считаем разумными для всех интеграций

Источником правды о персонажах на начало игры является данные из joinrpg. Это даст мастерам возможность вести всю информацию по игре в одном месте, использовать удобные и привычные инструменты для управления.
Expand All @@ -17,7 +17,7 @@
3. На игре менять роль игроку (выпуск второй ролью).

Поля персонажа
-----
--------------
Для хранения всех данных по персонажу надо использовать поля персонажа. В API это называется ``CharacterFields``.

Обратите внимание, что дополнительные данные по полям (например, метаданные по вариантам выпадаек) можно хранить в поле ``ProgrammaticalValue`` и загрузить при помощи `MetaDataApi_GetFieldsList <https://joinrpg.ru/swagger/index.html#/MetaDataApi/get_x_game_api__projectId__metadata_fields>`_.
Expand All @@ -30,28 +30,29 @@
2. Использовать «красивый», игровой логин, который берется из какого-то поля персонажа, например ``dartvader@empire.local``

Пароль
-----
------
Пароль в вашу систему рекомендуем хранить в поле персонажа типа PIN-код. Он будет создан автоматически (но при желании вы сможете вручную его отредактировать).

«В игре»
-------
--------

У персонажа есть флаг «В игре» — ``InGame``:

- становится ``true``, если игрок прошел регистрацию на игре;
- становится ``false``, если игрок был выпущен новой ролью. В идеале он мог бы становится false, если бы Система сообщала joinrpg о смерти персонажа, но такой функционал не был реализован.

Для NPC он всегда ``false``, их надо обрабатывать отдельно (`#1034 <https://github.com/joinrpg/joinrpg-net/issues/1034>`_)


Использование joinrpg в качестве бекенда
------------
----------------------------------------

Не рекомендуется использовать joinrpg в качестве непосредственного бекенда для вашего приложения. Мы не гарантируем соблюдения ваших требований по нагрузке и надежности. Правильный вариант, чтобы бекендом для вашего приложения был ваш сервис с вашей базой, который работает независимо от joinrpg.

Впрочем, если вы всегда запрашиваете данные `по одному персонажу по его Id <https://joinrpg.ru/swagger/index.html#/CharacterApi/get_x_game_api__projectId__characters__characterId_>`_, количество запросов не превышает сотен в час и вы готовы обеспечить стабильный канал до joinrpg, то это можно использовать как основной вариант. Преимущества: нет проблемы синхронизации.

Заливка Excel
--------------
-------------

.. note:: Подходит только для простых ИТ-систем и маленьких игр.

Expand All @@ -68,7 +69,7 @@
- не подходит, если игра большая (формирование Excel займет определенное время).

Онлайн-импорт
-----------------
-------------

.. note:: Мы рекомендуем этот вариант для сложных ИТ-систем

Expand Down
2 changes: 1 addition & 1 deletion docs/characters/slots.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _character-slot-label:

Шаблоны персонажей
============
==================

Шаблон персонажей - мастерский инструмент позволяющий создать одного персонажа (собственно, шаблон) на основании которого, при принятии заявки, будут созданы отдельные персонажи. Шаблону персонажей можно присваивать поля (в том числе и с предустановленным значением) и привязывать группы.

Expand Down
4 changes: 2 additions & 2 deletions docs/checkin/during.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Включение регистрации на полигоне
========================
=================================

Чтобы начать регистрацию приезжающих на игру, пройдите в своем проекте:
**Прочее > Настройки > Настройки регистрации**
Expand Down Expand Up @@ -33,7 +33,7 @@
:align: center
:alt: Экран регистрации

На экране регистрации выводится список `раздатки <http://docs.joinrpg.ru/ru/latest/plot/handout.html>`_ — физических вещей, которые получает игрок на полигоне непосредственно перед игрой. В том случае, если вы не формировали конверты для игроков заранее, игрок может получить требуемые вещи по этому списку прямо на регистрации.
На экране регистрации выводится список `раздатки </plot/handout.html>`_ — физических вещей, которые получает игрок на полигоне непосредственно перед игрой. В том случае, если вы не формировали конверты для игроков заранее, игрок может получить требуемые вещи по этому списку прямо на регистрации.

После нажатия кнопки «Зарегистрировать игрока» статус заявки меняется на «Игрок заехал», она учитывается в списке зарегистированных игроков и больше не отображается в списке персонажей, доступных для регистрации. В заявке автоматически оставляется комментарий «Пройдена регистрация на полигоне» от имени зарегистрировавшего мастера.

Expand Down
4 changes: 2 additions & 2 deletions docs/checkin/second-roles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

Выберите опцию «Разрешить выпуск вторыми ролями». Сохраните настройки.

Выпустить второй ролью можно только игрока, первая заявка которого на игру прошла `процесс регистрации <http://docs.joinrpg.ru/ru/latest/checkin/during.html>`_. Непринятые заявки и незарегистрированных игроков выпустить второй ролью нельзя.
Выпустить второй ролью можно только игрока, первая заявка которого на игру прошла `процесс регистрации </checkin/during.html>`_. Непринятые заявки и незарегистрированных игроков выпустить второй ролью нельзя.

.. figure:: new_role.png
:scale: 100 %
Expand All @@ -25,7 +25,7 @@
:align: center
:alt: Поиск по имени персонажа

После нажатия кнопки «Выпустить второй ролью» вы перейдете в интерфейс регистрации игрока новым персонажем. В том случае, если у персонажа, которым вы пытаетесь выпустить второй ролью, не заполнены какие-то обязательные поля, регистрация будет невозможна, но заявка уже будет привязана к этому персонажу. Перейдите на страницу персонажа и заполните все обязательные и рекомендуемые поля персонажа, `повторно пройдите процесс регистрации на полигоне <http://docs.joinrpg.ru/ru/latest/checkin/during.html>`_ для автоматически созданной заявки во второй роли.
После нажатия кнопки «Выпустить второй ролью» вы перейдете в интерфейс регистрации игрока новым персонажем. В том случае, если у персонажа, которым вы пытаетесь выпустить второй ролью, не заполнены какие-то обязательные поля, регистрация будет невозможна, но заявка уже будет привязана к этому персонажу. Перейдите на страницу персонажа и заполните все обязательные и рекомендуемые поля персонажа, `повторно пройдите процесс регистрации на полигоне </checkin/during.html>`_ для автоматически созданной заявки во второй роли.

.. hint:: Через меню Персонажи > Проблемные персонажи мастера могут заранее заполнить недостающие поля, тогда выпуск новыми ролями будет происходить максимально оперативно.

Expand Down
2 changes: 1 addition & 1 deletion docs/checkin/statistic.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Статистика зарегистрированных
========================
=============================

Статистика по ходу регистрации доступна по ссылке **Прочее > Регистрация > Статистика по регистрации**.
Показывается число принятых заявок, еще не прошедших регистрацию.
Expand Down
Loading
Loading