Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/U1805/momotalk
Browse files Browse the repository at this point in the history
  • Loading branch information
Bill-Haku committed Feb 23, 2024
2 parents 23a6443 + 12828f1 commit d68c223
Show file tree
Hide file tree
Showing 259 changed files with 10,058 additions and 39,075 deletions.
53 changes: 53 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 将静态内容部署到 GitHub Pages 的简易工作流程
name: Deploy static content to Pages

on:
# 仅在推送到默认分支时运行。
push:
branches: ['main']

# 这个选项可以使你手动在 Action tab 页面触发工作流
workflow_dispatch:

# 设置 GITHUB_TOKEN 的权限,以允许部署到 GitHub Pages。
permissions:
contents: read
pages: write
id-token: write

# 允许一个并发的部署
concurrency:
group: 'pages'
cancel-in-progress: true

jobs:
# 单次部署的工作描述
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Node
uses: actions/setup-node@v3
with:
node-version: 18
cache: 'npm'
- name: Install dependencies
run: npm install
- name: Build
run: npm run build
- name: Copy 404.html
run: npm run deploy
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload dist repository
path: './docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ coverage
*.njsproj
*.sln
*.sw?

/.vscode/
2 changes: 1 addition & 1 deletion .prettierrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"semi": false,
"tabWidth": 4,
"singleQuote": true,
"printWidth": 110,
"printWidth": 90,
"trailingComma": "none"
}
3 changes: 0 additions & 3 deletions .vscode/extensions.json

This file was deleted.

51 changes: 24 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,46 +13,36 @@
<sub>Set your Creative Idea free!</sub>
</div>

[中文说明](./README-zh.md)
[English](./README.md) | [简体中文](./docs/README-zh_cn.md) | [繁體中文](./docs/README-zh_tw.md)


## Feature

- **Searchable**: search students by names, romajis, and even nicknames. 🔍️
- **Custom role**: chat as Students, Sensei, and Custom roles. 🎅
- **Story Event**: send Images/Stickers/Story Event during the chat. ❤️
- **Diverse Event**: send Images/Stickers(Chatroom&Character)/Reply Box/Story Event during the chat. ❤️
- **Flexible Editor**: the chat box can be Inserted, Editted, Deleted, Dragged. 👍
- **Easy to Share**: save the conversation as an image and share your friends. 🖼️
- **Fast restart**: your conversation won't be lost the next time you open browser. 📌
- **Multiple Languages**: support Chinese(Simplified & Traditional), Japanese, Korean, and English. 🌐
- **Momotalk Player**: you can also use it to read Momotalk stories from game. ▶️

[Try it!](https://u1805.github.io/momotalk)

## Experimental Feature

> This section contains features that are still unstable.
- **A.R.O.N.A**: Provides an interactive experience with the virtual assistant ARONA. 💬

## Preview

![img11](./assets/演示1.webp)
![img12](./assets/演示2.webp)
<details style="border: 1px solid #aaa;
border-radius: 4px;
padding: 0.5em 0.5em 0;">
<summary style="font-weight: bold;
margin: -0.5em -0.5em 0;
padding: 0.5em;">What you can send</summary>
<ul>
<li>Student</li>
<li>Student (More Appearance)</li>
<li>Custom Character</li>
<li>Sensei</li>
<li>Story Box</li>
<li>Message Box</li>
<li>Sticker</li>
<li>Photo</li>
</ul>
<img src="./assets/支持样式预览.webp">
</details>
![student](./docs/assets/演示1.webp)
![chat](./docs/assets/演示2.webp)

## How to use

![guide](./assets/功能说明-en.png)
[Quick start](./docs/How-to-use.md)

## Star History

Expand All @@ -67,12 +57,19 @@ This project is inspired by:
- [blacktunes/juus-maker](https://github.com/blacktunes/juus-maker)
- [ClosureTalk/closure-talk](https://github.com/ClosureTalk/closure-talk)

Character metadata from:
Character metadata and assets from:

- [lonqie/SchaleDB](https://github.com/lonqie/SchaleDB)
- [Bluearchive.Fandom](https://bluearchive.fandom.com)
- [Ba.Gamekee](https://ba.gamekee.com/)
- [bluearchive.fandom](https://bluearchive.fandom.com)
- [kivo.wiki](https://kivo.wiki/)
- [ba.gamekee](https://ba.gamekee.com/)

ARONA prompts:

- [ZiChenStudio/ChatGPT-Arona](https://github.com/ZiChenStudio/ChatGPT-Arona)

## Copyrights

Blue Archive avatar and stamp copyrights belong to Yostar & NEXON Games
This application is not affiliated with Yostar & NEXON Games.

All information and assets used are the property and copyright of the respective authors.
Binary file removed assets/img0.png
Binary file not shown.
Binary file removed assets/img1.png
Binary file not shown.
Binary file removed assets/img10.png
Binary file not shown.
Binary file removed assets/img11.png
Binary file not shown.
Binary file removed assets/img12.png
Binary file not shown.
Binary file removed assets/img13.png
Binary file not shown.
Binary file removed assets/img2.png
Binary file not shown.
Binary file removed assets/img3.png
Binary file not shown.
Binary file removed assets/img4.png
Binary file not shown.
Binary file removed assets/img5.png
Binary file not shown.
Binary file removed assets/img6.png
Binary file not shown.
Binary file removed assets/img7.png
Binary file not shown.
Binary file removed assets/img8.png
Binary file not shown.
Binary file removed assets/img9.png
Binary file not shown.
Binary file removed assets/功能说明-en.png
Binary file not shown.
Binary file removed assets/功能说明.png
Binary file not shown.
Binary file removed assets/支持样式预览.webp
Binary file not shown.
Binary file removed assets/演示1.webp
Binary file not shown.
Binary file removed assets/演示2.webp
Binary file not shown.
Binary file removed docs/BG_MainOffice.jpg
Binary file not shown.
152 changes: 152 additions & 0 deletions docs/How-to-use.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
![banner](./assets/演示2.webp)

# 食用说明 · How to use

## 📚侧边栏 · Sidebar

💾 侧边栏下方三个按钮分别是「**切换语言**」「**重置**」和「**下载**为图片」

Below, there are three buttons: "**Switch languages**", "**Reset**" and "**Download** as image".

## 🎓学生列表 · Student List

🔍 点击右侧的**学校标志**,筛选学校;上方的**搜索栏**(快捷键 `/`),支持汉字、罗马音,以及游戏黑话

Click on the **school icons**: Filter students by school. **Search bar** at the top(Shortcut key `/`), supports use Chinese , romaji as keywords

<br/>

📜 搜索栏右侧的按钮:在「已实装角色」和「未实装角色」之间**切换列表**

Clicking the button on the right side of the search bar allows you to toggle between the "Implemented Characters" and "Unimplemented Characters" lists

<p align="center">
<img src="../public/img/switchlsit.webp" alt="switch_list" style="width:50%">
</p>

🔄 头像标着 `+` 的学生:点击头像切换 **差分**

Students with a \`+\` on their avatars: Click on the avatar to switch **appearances**.

<p align="center">
<img src="../public/img/appearence.webp" alt="appearence" style="width:50%">
</p>


📝 进入编辑界面后,点选学生列表可以将学生加入右下角的候选列表,方便后续使用

Upon entering the editing interface, selecting students from the list will add them to the candidate list in the bottom right corner for easy access

## 🖌️编辑界面 · Edit

在编辑界面,下方分别是「发送栏」和「候选列表」

In the editing interface, there are the "Message Bar" and the "Candidate List" at the bottom

### 🎭 选择身份 · Select a Role

候选列表前四项为「**老师**」「**羁绊剧情**」「**回复**」「**系统消息**」,最后一个按钮用于**添加自定义角色**

The first four items in the candidate list are "**Sensei**", "**Story Event**", "**Reply Box**", and "**System Message**". The last button is for **adding custom characters**.

<p align="center">
<img src="../public/img/sendbar.webp" alt="sendbar" style="width:50%">
</p>

### 🌄 发送消息 · Send Messages

选择身份后在发送栏**发送消息或图片**(大小限制为 1MB)

老师和学生身份,点击发送栏的头像能够发送游戏中的聊天室**贴图**。此外,这里也可以选择角色的表情差分图片。

After selecting a role, you can **send messages or images** in the message bar (size limit is 1MB).

If the current role is a teacher or student, clicking on the avatar in the message bar allows you to send in-game chatroom **stickers**. In addition, student face variations is considered as a kind of special stickers too.

<p align="center">
<img src="../public/img/stickers.webp" alt="stickers" style="width:45%">
<img src="../public/img/stickers2.webp" alt="face variations" style="width:45%">
</p>


### ✏️ 编辑消息 · Edit Messages

你可以通过类似 [markdown](https://markdown.com.cn/basic-syntax/) 的语法发送一些**特殊的文字样式**

You can use a syntax similar to [markdown](https://www.markdownguide.org/basic-syntax/) to send some **special text styles**.

| 语法 Usage | 说明 Description |
| ---- | ---- |
| \# Heading level 1 | 一级标题 |
| \#\# Heading level 2 | 二级标题 |
| \#\#\# Heading level 3 | 三级标题 |
| \*\*Bold text\*\* | 粗体 |
| \*Italic text\* | 斜体 |
| \*\*\*Bold italic text\*\*\* | 粗斜体 |
| \~\~Delete line\~\~ | 删除线 |
| \[color:red;font-size:10px](Font style) | 字体样式 |

> ① 该字体的粗体在某些浏览器上可能无法显示
>
> ② 可以通过使用反斜杠字符 `\` 从而达到转义目的(`#` `*` `~`)。例如:`\#` 可以输出 # 而不变为标题
>
> ① The bold style of this font may not display correctly on certain browsers.
>
> ② Escaping can be achieved by using the backslash character \ (for `#`, `*`, `~`). For example, `\#` will output # instead of being interpreted as a heading.

遵循 **所见即所得** 的设计思想,消息发送后仍可以对元素直接编辑,如修改、拖拽、删除等

- **修改**
- 点选 *文本* 或者 *角色名字* 会出现文本框,在其中编辑即可
- 对于 *图片* 消息,点击后重新上传图片
- *回复* 键入回车会出现下一个选项框
- **拖拽**:按住消息上下移动可以调整消息之间的顺序
- **删除**:光标 *停留* 在元素上时,出现 `x` 删除按钮
- **插入**:光标 *停留* 在元素上时,出现 `` 插入按钮,之后发送消息会插入到此处
- **快捷键**:撤销 `Ctrl+Z`,重做 `Ctrl+Shift+Z`, 软换行 `Shift+Enter`

Following the **WYSIWYG** (What you see is what you get) design philosophy, elements can still be directly edited after sending messages, such as modifying, dragging, deleting, etc.

- **Modifying**: Supports editing *text*, *character names*, and *images*.
- For " *Text* " and " Character name ", simply click to reveal a text box for editing.
- For " *Image* ", click to upload a new image.
- For " *Reply* ", pressing Enter will bring up the next option.
- **Dragging**: Holding and moving messages up and down can adjust the order between messages.
- **Deleting**: When the cursor *hovers* over an element, the delete button `x` will appear near the element.
- **Inserting**: When the cursor is *hovering* over an element, the insert button `` appears, then the message will be inserted here.
- **Shortcut key**: undo `Ctrl+Z`, redo `Ctrl+Shift+Z`, and line break `Shift+Enter`

<p align="center">
<img src="../public/img/edit.webp" alt="edit" style="width:50%">
</p>

### 📜 中断消息流 · Interrupt the Message Flow

通常单个学生的消息是连续的。如果想要中断消息流,可以尝试点击学生消息中“头像”下方的区域。

Normally, messages from a single student are continuous. If you wish to interrupt the message flow, you can try clicking below the "avatar" in the student's message.

<div align="center">
<img src="../public/img/splitmessage.webp" alt="split" style="width:50%">

<p>via <a href="https://twitter.com/YuzuTalkJP/status/1421448297030381569">Yuzutalk</a> </p>
</div>

## 🌟 其他

右上角的设置按钮中有切换 yuzutalk 样式、对话文件的导出导入等功能

In the top-right corner, the settings button provides functions such as switching to Yuzutalk styles and exporting/importing conversation files.

本应用适配移动端,但是因为能力有限,基本就是看看得了的程度,更推荐电脑操作 💻📱

The application is adapted for mobile devices, but due to limited capabilities, it's recommended to use it on a computer for a better experience 💻📱

<br/>

游戏黑话搜索也是,如果发现有遗漏或者写错的,**欢迎提 [issue](https://github.com/U1805/momotalk/issues)[pr](https://github.com/U1805/momotalk/pulls) 补充**,当然对功能和代码的好想法和优化也欢迎欢迎 ❤️

If you notice any omissions or mistakes, **please feel free to raise an [issue](https://github.com/U1805/momotalk/issues) or submit a [pull request](https://github.com/U1805/momotalk/pulls) for correction**. Of course, ideas and optimizations for features and code are also very much welcomed ❤️

![thanks](../public/img/kyk.gif)
52 changes: 24 additions & 28 deletions README-zh.md → docs/README-zh_cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,49 +13,38 @@
<sub>来创造脑洞大开的故事吧!</sub>
</div>

[English](../README.md) | [简体中文](./README-zh_cn.md) | [繁體中文](./README-zh_tw.md)

## 特性

- **可搜索学生**: 能够通过学生名字、名字罗马音,甚至游戏黑话快速搜索学生. 🔍️
- **可搜索学生**: 能够通过学生名字、名字罗马音,甚至昵称快速搜索学生. 🔍️
- **自定义角色**: 发言角色包括老师、学生,也可以上传图片自定义角色. 🎅
- **消息类型丰富**: 除了文字还能发送图片、贴图和羁绊剧情框. ❤️
- **消息类型丰富**: 除了文字还能发送图片、贴图(聊天室&角色差分)、选项框和羁绊剧情框. ❤️
- **灵活的编辑**: 聊天框可随意插入、删除、编辑、拖动位置. 👍
- **便于分享**: 对话可以保存为图片方便分享给小伙伴. 🖼️
- **保留历史记录**: 重启浏览器也可以继续上一次的对话. 📌
- **多语言支持**: 支持中文(简体和繁体)、日文、韩文和英文. 🌐
- **Momotalk 播放器**: 能够播放游戏中的 Momotalk 对话剧情. ▶️

[等不及了快端上来吧!](https://u1805.github.io/momotalk)

## 实验特性

> 这部分特性功能仍不稳定
- **A.R.O.N.A**: 提供与虚拟助手阿罗娜的互动体验. 💬

## 预览

![img11](./assets/演示1.webp)
![img12](./assets/演示2.webp)
<details style="border: 1px solid #aaa;
border-radius: 4px;
padding: 0.5em 0.5em 0;">
<summary style="font-weight: bold;
margin: -0.5em -0.5em 0;
padding: 0.5em;">支持的样式一览</summary>
<ul>
<li>学生</li>
<li>学生差分</li>
<li>自定义角色</li>
<li>老师</li>
<li>羁绊剧情</li>
<li>系统通知</li>
<li>贴图(表情包)</li>
<li>图片</li>
</ul>
<img src="./assets/支持样式预览.webp">
</details>
![student](./assets/演示1.webp)
![chat](./assets/演示2.webp)

## 使用

![guide](./assets/功能说明.png)
[How To Use](./How-to-use.md)

## Star

喜欢的话请点点Star,谢谢喵=\^ω\^=

[![Star History Chart](https://api.star-history.com/svg?repos=U1805/momotalk)](https://star-history.com/#U1805/momotalk)

## 感谢
Expand All @@ -70,9 +59,16 @@
角色数据来源:

- [lonqie/SchaleDB](https://github.com/lonqie/SchaleDB)
- [Bluearchive.Fandom](https://bluearchive.fandom.com)
- [Ba.Gamekee](https://ba.gamekee.com/)
- [bluearchive.fandom](https://bluearchive.fandom.com)
- [kivo.wiki](https://kivo.wiki/)
- [ba.gamekee](https://ba.gamekee.com/)

AI 阿罗娜提示词:

- [ZiChenStudio/ChatGPT-Arona](https://github.com/ZiChenStudio/ChatGPT-Arona)

## 版权

项目中角色、素材版权均属于 Yostar & NEXON Games
本项目 与 Yostar & NEXON Games 没有关联。

项目中使用的所有角色信息和素材版权均属于各自作者。
Loading

0 comments on commit d68c223

Please sign in to comment.