Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackiexiao committed Jul 27, 2023
1 parent 2436507 commit e752e20
Show file tree
Hide file tree
Showing 7 changed files with 47 additions and 210 deletions.
37 changes: 14 additions & 23 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -110,16 +110,17 @@ export default {
description: 'Gennia Cyber Document.',
lastUpdated: true,

head: [
['link', { rel: 'icon', href: '/assets/img/favicon.png' }]
],
head: [['link', { rel: 'icon', href: '/assets/img/favicon.png' }]],

// Theme related configurations.
themeConfig: {
siteTitle: '官方文档',
logo: '/assets/img/logo.png',
nav: [
{ text: '更新记录', link: 'https://github.com/GenniaApp/Gennia/releases' }
{
text: '更新记录',
link: 'https://github.com/GenniaApp/GenniaServer2/releases',
},
],
sidebar: [
{
Expand All @@ -129,42 +130,32 @@ export default {
{ text: '游戏速度', link: '/quick-start/speed' },
{ text: '地图和地形', link: '/quick-start/map' },
{ text: '游玩操作', link: '/quick-start/keys' },
]
},
{
text: 'GenniaServer',
items: [
{ text: '服务器部署', link: '/server/' }
]
],
},
{
text: 'Bot 开发',
items: [
{ text: 'API 介绍', link: '/bot-api/' },
{ text: 'socket 接收', link: '/bot-api/on' },
{ text: 'socket 发送', link: '/bot-api/emit' }
]
}
items: [{ text: 'API 介绍', link: '/bot-api/' }],
},
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/GenniaApp/Gennia' }
{ icon: 'github', link: 'https://github.com/GenniaApp/GenniaServer2' },
],
editLink: {
pattern: 'https://github.com/GenniaApp/docs/edit/main/docs/:path',
text: '在 GitHub 上编辑此页'
text: '在 GitHub 上编辑此页',
},
docFooter: {
prev: '上一篇',
next: '接下来阅读'
next: '接下来阅读',
},
footer: {
message: 'Gennia 的技术还很稚嫩,她还在成长. . .',
copyright: 'Copyright © 2022-present Reqwey'
copyright: 'Copyright © 2022-present GenniaApp',
},
// algolia: {
// appId: 'QE7LMUJ22V',
// apiKey: '3e9460bbaac6905c7e1eda81762b52f2',
// indexName: 'genniaSearch'
// }
}
}
},
};
39 changes: 0 additions & 39 deletions docs/bot-api/emit.md

This file was deleted.

6 changes: 5 additions & 1 deletion docs/bot-api/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Bot 开放平台

本文介绍 Gennia 的 `socket API`。以便开发者造出相应的游戏机器人。
本文介绍 Gennia 的 `socket API`。以便开发者造出相应的游戏机器人。

Socket emit / on api 详见 [官方 Bot 示例](https://github.com/GenniaApp/Genniabot)

提供了多种语言 python + cpp / typescript 的示例。
91 changes: 0 additions & 91 deletions docs/bot-api/on.md

This file was deleted.

25 changes: 7 additions & 18 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
layout: home
title: '首页'
hero:
name: Hi, Gennia(1.0.11)
text:
tagline: 创新的将军棋游戏引擎。由 Electron 驱动。
name: Hi, Gennia(beta)
text:
tagline: 创新的将军棋游戏引擎。由 Nextjs / express 驱动。
image:
src: /assets/img/logo.png
alt: Gennia
Expand All @@ -14,28 +14,17 @@ hero:
link: /quick-start/
- theme: alt
text: 送我一颗星星⭐
link: https://github.com/GenniaApp/Gennia
- theme: blue
text: 下载 Windows 版
link: https://github.com/GenniaApp/Gennia/releases/download/1.0.10patch2/Gennia.Setup.1.0.11.exe
- theme: teal
text: 下载 macOS 版
link: https://github.com/GenniaApp/Gennia/releases/download/1.0.10patch2/Gennia-1.0.10-patch2.dmg
link: https://github.com/GenniaApp/GenniaServer2

features:
- icon:
src: /assets/img/ui.svg
alt: 'UI 界面,赏心悦目'
title: 'UI 界面,赏心悦目'
details: 'Electron 应用特有的高颜值,让游戏体验更美好'
- icon:
- icon:
src: /assets/img/performance.svg
alt: '随心游走,毫无延迟'
title: '随心游走,毫无延迟'
details: 'Socket.IO 4.5,一次握手,带来畅快的游戏体验。'
- icon:
- icon:
src: /assets/img/easy.svg
alt: '随时随地,开箱即用'
title: '随时随地,开箱即用'
details: '无论是局域网互联,还是连接至 GenniaServer,Gennia 都能胜任。'
---
---
22 changes: 21 additions & 1 deletion docs/quick-start/keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## 50%

两次点击一个你拥有的格子 / `Z` 键(>v1.0.7)可以激发,可以抽取当前格子兵力数 $/2$ 下取整的兵力放置在新的位置上。
两次点击一个你拥有的格子 / `Z` 键可以激发,可以抽取当前格子兵力数 $/2$ 下取整的兵力放置在新的位置上。

## 攻占

Expand All @@ -29,3 +29,23 @@
## Q 键

清空**操作序列**

## G / K 键

定位到你的 Generals / King 方块

## 1 / 2 / 3 键

缩放地图到预设大小

## 滚轮

缩放地图

## ESC 键

投降 或 退出游戏

## Enter 回车键

定位到聊天框,发送聊天消息
37 changes: 0 additions & 37 deletions docs/server/index.md

This file was deleted.

0 comments on commit e752e20

Please sign in to comment.