Skip to content

Commit a0a0ced

Browse files
committed
docs: add GBA plugin documentation in English and Chinese
1 parent 398d8d7 commit a0a0ced

4 files changed

Lines changed: 81 additions & 0 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,10 @@ export default defineConfig({
107107
text: 'Gamepad',
108108
link: '/guide/official-plugins/gamepad',
109109
},
110+
{
111+
text: 'GBA',
112+
link: '/guide/official-plugins/gba',
113+
},
110114
],
111115
},
112116
],
@@ -193,6 +197,10 @@ export default defineConfig({
193197
text: '手柄测试',
194198
link: '/zh/guide/official-plugins/gamepad',
195199
},
200+
{
201+
text: 'GBA',
202+
link: '/zh/guide/official-plugins/gba',
203+
},
196204
],
197205
},
198206
],

docs/guide/official-plugins/gba.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# tinker-gba
2+
3+
A GBA emulator plugin for [TINKER](https://github.com/liriliri/tinker), supporting ROM loading with keyboard and gamepad controls and fullscreen playback.
4+
5+
![Screenshot](https://raw.githubusercontent.com/liriliri/tinker-plugins/master/packages/tinker-gba/screenshot.png)
6+
7+
## Features
8+
9+
- **GBA Emulation** — full Game Boy Advance emulation with keyboard and gamepad controls
10+
- **ROM Loading** — load `.gba` files via file picker or drag and drop
11+
- **Pause / Resume** — pause and continue gameplay at any time
12+
- **Reset** — restart the current ROM
13+
- **Save / Load State** — save or restore game progress
14+
- **Mute / Unmute** — toggle audio on or off
15+
- **Fullscreen** — enter fullscreen mode for immersive gameplay
16+
- **Custom Key Mapping** — customize keyboard and gamepad bindings
17+
- **Dark Mode** — support for dark theme
18+
19+
## Installation
20+
21+
Download and install [TINKER](https://tinker.liriliri.io/), then run:
22+
23+
```bash
24+
npm i -g tinker-gba
25+
```
26+
27+
## Usage
28+
29+
1. Click **OPEN ROM** to load a `.gba` file, or drag and drop it onto the screen
30+
2. Use keyboard or gamepad to play
31+
3. Click **PAUSE** / **RESUME** to pause or continue the game
32+
4. Click **RESET** to restart the current ROM
33+
5. Click **SAVE STATE** / **LOAD STATE** to save or restore progress
34+
6. Click **MUTE** / **UNMUTE** to toggle audio
35+
7. Click **FULLSCREEN** to enter fullscreen mode
36+
8. Click **KEYMAP** to customize keyboard and gamepad bindings
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# tinker-gba
2+
3+
适用于 [TINKER](https://github.com/liriliri/tinker) 的 GBA 模拟器插件,支持 ROM 加载、键盘和手柄控制以及全屏播放。
4+
5+
![截图](https://raw.githubusercontent.com/liriliri/tinker-plugins/master/packages/tinker-gba/screenshot.png)
6+
7+
## 功能特性
8+
9+
- **GBA 模拟** — 完整的 Game Boy Advance 模拟,支持键盘和手柄控制
10+
- **ROM 加载** — 通过文件选择器或拖放加载 `.gba` 文件
11+
- **暂停 / 继续** — 随时暂停和继续游戏
12+
- **重置** — 重新启动当前 ROM
13+
- **保存 / 加载状态** — 保存或恢复游戏进度
14+
- **静音 / 取消静音** — 切换音频开关
15+
- **全屏** — 进入全屏模式以获得沉浸式体验
16+
- **自定义按键映射** — 自定义键盘和手柄按键绑定
17+
- **深色模式** — 支持深色主题
18+
19+
## 安装
20+
21+
下载并安装 [TINKER](https://tinker.liriliri.io/),然后运行:
22+
23+
```bash
24+
npm i -g tinker-gba
25+
```
26+
27+
## 使用方法
28+
29+
1. 点击 **OPEN ROM** 加载 `.gba` 文件,或将文件拖放到屏幕上
30+
2. 使用键盘或手柄进行游戏
31+
3. 点击 **PAUSE** / **RESUME** 暂停或继续游戏
32+
4. 点击 **RESET** 重新启动当前 ROM
33+
5. 点击 **SAVE STATE** / **LOAD STATE** 保存或恢复进度
34+
6. 点击 **MUTE** / **UNMUTE** 切换音频
35+
7. 点击 **FULLSCREEN** 进入全屏模式
36+
8. 点击 **KEYMAP** 自定义键盘和手柄按键绑定

skills/add-official-plugin-doc/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,5 @@ In `docs/.vitepress/config.mts`, add an entry to BOTH sidebar sections:
4848
- The sidebar item `text` MUST come from `package.json`: English uses `tinker.name`, Chinese uses `tinker.locales.zh-CN.name` (if it exists, otherwise fall back to `tinker.name`)
4949
- The file name under `official-plugins/` should be the plugin name without the `tinker-` prefix (e.g. `tinker-whois``whois.md`)
5050
- The sidebar category is `Official Plugins` (EN) / `官方插件` (ZH) with `collapsed: false`
51+
- Sidebar items MUST be sorted by plugin ID in alphabetical order (e.g. bilibili-downloader → electron-debug → emoji → gamepad → gba)
5152
- Screenshot images should reference the raw GitHub URL from the README

0 commit comments

Comments
 (0)