Skip to content

Commit 74a2e08

Browse files
committed
Merge branch 'develop'
2 parents a4f0611 + f3845d7 commit 74a2e08

4 files changed

Lines changed: 85 additions & 1 deletion

File tree

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
run: |
3131
sudo apt-get update
3232
sudo apt-get install -y libcairo2-dev pkg-config python3-dev
33-
pip install cairosvg pycairo mkdocs mkdocs-material mkdocs-mermaid2-plugin mkdocs-minify-plugin mkdocs-macros-plugin mkdocs-llmstxt
33+
pip install cairosvg pycairo mkdocs mkdocs-material mkdocs-mermaid2-plugin mkdocs-minify-plugin mkdocs-macros-plugin mkdocs-llmstxt mkdocs-static-i18n
3434
3535
- name: Build site
3636
run: mkdocs build --site-dir public

docs/index.ja.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: RIMAPI
3+
description: RIMAPIは、RimWorldにREST APIサーバーを追加する強力なMODです。
4+
---
5+
6+
# RIMAPI - RimWorld REST API
7+
8+
![RIMAPI Logo](https://raw.githubusercontent.com/IlyaChichkov/RIMAPI/8cdebce963f69c2aeeb50676ab4b994309a1835b/About/preview.png)
9+
10+
[はじめに](quick_start.md){ .md-button .md-button--primary }
11+
[貢献する](contributors_guide/contribute.md){ .md-button }
12+
13+
## 概要
14+
15+
RIMAPIは、RimWorldにREST APIサーバーを追加し、プログラムを通じてゲームと対話できるようにする強力なMODです。コロニーのステータス監視、ポーン(入植者)の制御、リソースの管理、外部ツールやインテグレーションの構築が可能になります。
16+
17+
### 主な機能
18+
19+
- **📡 RESTful API** - ゲームデータ用の標準的なHTTPエンドポイント
20+
- **🔔 リアルタイムイベント** - ライブ更新用のServer-Sent Events (SSE)
21+
- **🔌 拡張可能なアーキテクチャ** - 他のMODが独自のエンドポイントを追加可能
22+
- **🛡️ 安全でノンブロッキング** - リクエストキューイングによりメインスレッドで安全に動作
23+
- **📚 自動ドキュメント生成** - 複数のフォーマットに対応した自己文書化API
24+
25+
### 次のステップ
26+
27+
- [APIドキュメント](https://ilyachichkov.github.io/RIMAPI/api.html)
28+
- [LLMフォーマット](https://ilyachichkov.github.io/RIMAPI/llms-full.txt)

docs/index.ru.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: RIMAPI
3+
description: RIMAPI — это мод, который добавляет сервер REST API в RimWorld.
4+
---
5+
6+
# RIMAPI - REST API для RimWorld
7+
8+
![RIMAPI Logo](https://raw.githubusercontent.com/IlyaChichkov/RIMAPI/8cdebce963f69c2aeeb50676ab4b994309a1835b/About/preview.png)
9+
10+
[Быстрый старт](quick_start.md){ .md-button .md-button--primary }
11+
[Внести вклад в код](contributors_guide/contribute.md){ .md-button }
12+
13+
## Обзор
14+
15+
RIMAPI — это мощный мод, добавляющий в RimWorld сервер REST API, который позволяет программно взаимодействовать с игрой. Отслеживайте статус колонии, управляйте пешками и ресурсами, игровыми настройками, а также создавайте внешние инструменты и интеграции.
16+
17+
### Основные возможности
18+
19+
- **📡 RESTful API** — Стандартные HTTP-эндпоинты для получения игровых данных
20+
- **🔔 События в реальном времени** — Server-Sent Events (SSE) для получения обновлений в реальном времени
21+
- **🔌 Расширяемая архитектура** — Другие моды могут добавлять свои собственные эндпоинты
22+
- **🛡️ Безопасность и отсутствие блокировок** — Работает в основном потоке с использованием очередей запросов
23+
- **📚 Автоматическая документация** — Самодокументируемое API с поддержкой нескольких форматов
24+
25+
### Что дальше
26+
27+
- [Документация API](https://ilyachichkov.github.io/RIMAPI/api.html)
28+
- [Формат для LLM](https://ilyachichkov.github.io/RIMAPI/llms-full.txt)

mkdocs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,24 @@ plugins:
5959
- offline
6060
- social
6161
- tags
62+
- i18n:
63+
docs_structure: suffix
64+
fallback_to_default: true
65+
languages:
66+
- build: true
67+
default: true
68+
locale: en
69+
name: English
70+
- build: true
71+
default: false
72+
locale: ja
73+
name: 日本語
74+
- build: true
75+
default: false
76+
locale: ru
77+
name: Русский
78+
reconfigure_material: true
79+
reconfigure_search: true
6280
- mermaid2:
6381
javascript: https://unpkg.com/mermaid@10.4.0/dist/mermaid.esm.min.mjs
6482
- minify:
@@ -103,6 +121,16 @@ markdown_extensions:
103121
format: !!python/name:pymdownx.superfences.fence_code_format
104122

105123
extra:
124+
alternate:
125+
- name: English
126+
link: /RIMAPI/
127+
lang: en
128+
- name: 日本語
129+
link: /RIMAPI/ja/
130+
lang: ja
131+
- name: Русский
132+
link: /RIMAPI/ru/
133+
lang: ru
106134
social:
107135
- icon: fontawesome/brands/github
108136
link: https://ilyachichkov.github.io/RIMAPI

0 commit comments

Comments
 (0)