miniapp

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 19 Open GitHub ↗

A miniapp for YouDao Dictionary Pen

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Miniapp

> [!WARNING]  
> This miniapp is still under development, and may have breaking changes without any notice.

## 功能特性 (Features)

这是一个为有道词典笔设计的工具箱应用，主要功能包括：

**AI 助手** - 一个强大的对话式 AI 工具：
- 支持 OpenAI 兼容 API 接口，可使用各种大语言模型
- 提供多轮对话功能，支持上下文记忆
- 对话历史管理，可创建、搜索、编辑和删除对话
- 消息编辑和重新生成，支持同一消息的多个变体（variant）
- 完整的 AI 参数配置：模型选择、温度、TopP、最大长度等
- 自定义系统提示词（system prompt）
- 软键盘输入支持，包括中文拼音输入
- 实时显示账户余额

This is a toolbox application designed for YouDao Dictionary Pen with the following main features:

**AI Assistant** - A powerful conversational AI tool:
- Supports OpenAI-compatible APIs, allowing use of various large language models
- Multi-turn conversation with context memory
- Conversation history management: create, search, edit, and delete conversations
- Message editing and regeneration with support for message variants
- Full AI parameter configuration: model selection, temperature, TopP, max length, etc.
- Custom system prompts
- Soft keyboard input with Chinese Pinyin support
- Real-time account balance display

## Requirements

Users using this miniapp should have a [supported YouDao Dictionary Pen](https://smart.youdao.com/dictPen).

## Preparation

1. Make sure you have a YouDao Dictionary Pen with `adb` enabled. You can use [the paper tool](https://github.com/langningchen/paper) to edit adb password easily or refer to [these discussions](https://github.com/orgs/PenUniverse/discussions/).
2. Connect your YouDao Dictionary Pen to your computer and login to it using `adb shell auth`.
3. Make sure you have `cmake`, `make`, `nodejs`, `pnpm`, `iconv` installed on a Ubuntu computer.
4. Clone this repository:
   ```bash
   git clone https://github.com/langningchen/miniapp.git
   cd miniapp
   ```

## Build

On Android:

1. Open the shell using `adb shell` and run the following command to check the version of system:
   ```bash
   curl -k -s https://raw.githubusercontent.com/langningchen/miniapp/refs/heads/main/tools/getVersionInfo.sh | bash
   ```
2. Pull the artifacts from the YouDao Dictionary Pen:
   ```bash
   adb pull /userdisk/Favorite/versionInfo.tar.gz ./versionInfo.tar.gz
   ```

On Ubuntu:

1. Extract the `versionInfo.tar.gz` file:
   ```bash
   tar -xzf versionInfo.tar.gz -C ./jsapi
   ```
2. Download and extract the correct toolchain in the `jsapi/toolchains` directory,
   your directory structure should look like this:
   ```
   miniapp/
   ├── jsapi/
   |   |-- include/
   |   |   |-- curl/
   |   |   |-- sqlite3/
   |   |-- lib/
   |   |   ├── libcurl.so
   |   |   ├── libsqlite3.so
   │   ├── src/
   │   ├── toolchains/
   │   │   ├── <toolchain_name>/
   │   │   │   ├── bin/
   │   │   │   ├── include/
   │   │   │   └── lib/
   ```
3. Install NodeJS dependencies using `pnpm`:
   ```bash
   pnpm -C ui install
   ```
4. Run the build script:
   ```bash
   ./tools/build.sh
   ```
5. After the build is complete, you will find the `miniapp.amr` file in the `dist` directory.

## Installation

1. Upload the `miniapp.amr` file to your YouDao Dictionary Pen using `adb push`:
   ```bash
   adb push miniapp.amr /userdisk/Favorite/miniapp.amr
   ```
2. Open the shell using `adb shell` and run the following command to install the miniapp:
   ```bash
   miniapp_cli install /userdisk/Favorite/miniapp.amr
   ```
3. After installation, you can find the miniapp in the app list of your YouDao Dictionary Pen.

## License

This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.

## Known Issues

See [GitHub Issues](https://github.com/langningchen/miniapp/issues).

miniapp

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README