diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 8a567cef0..09f2eab8a 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -106,8 +106,21 @@ export default defineConfig({ icon: 'lucide:rocket', items: [ { text: 'Introduction', link: withBase('/en/docs/overview/') }, - { text: 'About AI VTuber', link: withBase('/en/docs/overview/about-ai-vtuber') }, - { text: 'About Neuro-sama', link: withBase('/en/docs/overview/about-neuro-sama') }, + { + text: 'Guide', + items: [ + { + text: 'Guide to Desktop version', + link: withBase('/en/docs/overview/guide/tamagotchi/'), + items: [], + }, + { + text: 'Guide to Web version', + link: withBase('/en/docs/overview/guide/web/'), + items: [], + }, + ], + }, { text: 'Contributing', items: [ @@ -121,6 +134,8 @@ export default defineConfig({ }, ], }, + { text: 'About AI VTuber', link: withBase('/en/docs/overview/about-ai-vtuber') }, + { text: 'About Neuro-sama', link: withBase('/en/docs/overview/about-neuro-sama') }, ], }, { @@ -172,8 +187,21 @@ export default defineConfig({ icon: 'lucide:rocket', items: [ { text: '介绍', link: withBase('/zh-Hans/docs/overview/') }, - { text: '有关 AI VTuber', link: withBase('/zh-Hans/docs/overview/about-ai-vtuber') }, - { text: '有关 Neuro-sama', link: withBase('/zh-Hans/docs/overview/about-neuro-sama') }, + { + text: '指南', + items: [ + { + text: '桌面版上手指南', + link: withBase('/zh-Hans/docs/overview/guide/tamagotchi/'), + items: [], + }, + { + text: '网页版上手指南', + link: withBase('/zh-Hans/docs/overview/guide/web/'), + items: [], + }, + ], + }, { text: '参与贡献', items: [ @@ -187,6 +215,8 @@ export default defineConfig({ }, ], }, + { text: '有关 AI VTuber', link: withBase('/zh-Hans/docs/overview/about-ai-vtuber') }, + { text: '有关 Neuro-sama', link: withBase('/zh-Hans/docs/overview/about-neuro-sama') }, ], }, { diff --git a/docs/content/en/docs/overview/guide/tamagotchi/index.md b/docs/content/en/docs/overview/guide/tamagotchi/index.md new file mode 100644 index 000000000..03e256afa --- /dev/null +++ b/docs/content/en/docs/overview/guide/tamagotchi/index.md @@ -0,0 +1,4 @@ +--- +title: Guide to Desktop version +description: How to use Tamagotchi version of Project AIRI +--- diff --git a/docs/content/en/docs/overview/guide/web/index.md b/docs/content/en/docs/overview/guide/web/index.md new file mode 100644 index 000000000..98d7e57d8 --- /dev/null +++ b/docs/content/en/docs/overview/guide/web/index.md @@ -0,0 +1,4 @@ +--- +title: Guide to Web version +description: How to use Web version of Project AIRI +--- diff --git a/docs/content/en/docs/overview/index.md b/docs/content/en/docs/overview/index.md index 2239d9cc1..c42809de2 100644 --- a/docs/content/en/docs/overview/index.md +++ b/docs/content/en/docs/overview/index.md @@ -3,6 +3,96 @@ title: Introduction description: Get to know the UI of Project AIRI --- +### TL;DR + +Think of us as + +- open source re-creation of [Neuro-sama](https://www.youtube.com/@Neurosama) +- open source alternative to [Grok Companion](https://news.ycombinator.com/item?id=44566355) +- a Live2D, VRM (3D), and role playing with gaming, and application +awareness specialized [SillyTavern](https://github.com/SillyTavern/SillyTavern) +alternative. + +Have you dreamed about having a cyber living being (cyber waifu / husbando), +or digital companion that could play with and talk to you? + +With the power of modern large language models, platforms like +[Character.ai (a.k.a. c.ai)](https://character.ai) and +[JanitorAI](https://janitorai.com/), or applications like +[SillyTavern](https://github.com/SillyTavern/SillyTavern) is already a well-enough +solution for chat based, or visual adventure game like experience. + +> But, what about the abilities to play games? And see what you are coding +> at? Chatting while playing games, watching videos, and capable of doing many +> other things. + +Perhaps you know [Neuro-sama](https://www.youtube.com/@Neurosama) already, she is +currently the best companion capable of playing games, chatting, and interacting +with you and the participants (in VTuber community), some call this kind of being, +"digital human" too. **Sadly, it's not open sourced, you cannot interact with her after she went offline from live stream**. + +Therefore, this project, AIRI, offers another possibility here: +**let you own your digital life, cyber living, easily, anywhere, anytime**. + +## Getting started + +We do support both Web and Desktop. + +
+
+
+
+
+ Web + + Open + +
+
+
+
+ / +
+
+ Desktop + + Download + +
+
+ +Web is much minimum for accessing it anywhere, even on Mobile devices. +Desktop suits for more advanced usage such as VTuber streaming, computer use +and accessing to local LLMs where you don't need to pay for massive amount +of tokens for running AIRI. + +
+ +
+
+
+
+ Desktop +
+
+ How to use? +
+ + + + +## Contributing + For guides that help you understand how to contribute to this project, please refer to [Contributing](../overview/contributing/) page. For references Contributing help you design and improve the UI of Project AIRI, please refer to [Design Guidelines](../overview/contributing/design-guidelines/resources) page. diff --git a/docs/content/zh-Hans/docs/overview/guide/tamagotchi/index.md b/docs/content/zh-Hans/docs/overview/guide/tamagotchi/index.md new file mode 100644 index 000000000..dee5c49a5 --- /dev/null +++ b/docs/content/zh-Hans/docs/overview/guide/tamagotchi/index.md @@ -0,0 +1,4 @@ +--- +title: 桌面版上手指南 +description: 如何使用桌面版的 Project AIRI +--- diff --git a/docs/content/zh-Hans/docs/overview/guide/web/index.md b/docs/content/zh-Hans/docs/overview/guide/web/index.md new file mode 100644 index 000000000..1ce99dd8b --- /dev/null +++ b/docs/content/zh-Hans/docs/overview/guide/web/index.md @@ -0,0 +1,4 @@ +--- +title: 网页版上手指南 +description: 如何使用网页版的 Project AIRI +--- diff --git a/docs/uno.config.ts b/docs/uno.config.ts index 03c48e592..7711b9b14 100644 --- a/docs/uno.config.ts +++ b/docs/uno.config.ts @@ -1,3 +1,6 @@ +import type { Preset } from 'unocss' + +import { presetChromatic } from '@proj-airi/unocss-preset-chromatic' import { blackA, cyan, grass, green, indigo, mauve, purple, red, slate, teal, violet } from '@radix-ui/colors' import { defineConfig, presetAttributify, presetIcons, presetTypography, presetWebFonts, presetWind3, transformerDirectives, transformerVariantGroup } from 'unocss' @@ -7,10 +10,10 @@ export default defineConfig({ presetTypography({ cssExtend: { 'a': { - 'color': '#7f8993', + 'color': '#223f5dff', 'text-decoration': 'underline', 'text-decoration-style': 'dotted', - 'text-decoration-color': '#ced5e6', + 'text-decoration-color': '#9fa4b1ff', 'transition': 'color 0.2s ease-in-out', }, 'a:hover': { @@ -51,6 +54,13 @@ export default defineConfig({ }, }), presetIcons(), + presetChromatic({ + baseHue: 220.44, + colors: { + primary: 0, + complementary: 180, + }, + }) as Preset, ], content: { filesystem: [