Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@makeding
wzfdgh authored and makeding committed Jun 19, 2024
1 parent 521c056 commit 3f43dd7
Show file tree
Hide file tree
Showing 9 changed files with 247 additions and 192 deletions.
44 changes: 22 additions & 22 deletions docs/privacy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,33 @@ title: Privacy Policy
sidebar: false
---

## 1. We collect the following contents
## We collect the following

### Telegram user id
When you are using this bot, your Telegram user id may be recorded and associated with the bot.
The actions that trigger the recording of user ids are currently the following.
### User id
When you use the bot, your Telegram id may be recorded and associated with the bot.
There are currently a few actions that log user ids:

- Customize the reply format
- Generate telegraph pages
- Export author's all illusts
- Favorites colloction (coming soon)
- New illust push (coming soon)
- Customizing reply formats
- Generating a telegraph page
- When exporting all of an artist's work
- Favorites function (coming soon)
- Pushing the artist's work (coming soon)

All other actions bot will not record your information and will not associate your sent work with your id in any way.
In all other operations, bot does not record your information and does not associate the work you send with your id in any way.

### IP
bot / Cloudflare may get your current IP when you do the following
bot / Cloudflare may obtain your current IP when you do the following

- Visit the telegraph page (directly visit)
- Cloudflare provides a direct link to the illust
- bot provides a direct link to the ugoira
> There is no any traffic in our service when you're viewing Telegram instant view page
- When you saw this documents
- Accessing the telegraph page (not live preview)
- Cloudflare provides a direct link to the original image
- bot provides a direct link to the moving image

> (Telegraph pages are only opened in a browser, Telegram Instant Preview will not pass any traffic through the service)
- Accessing this document

## 2. security
bot does not have any user tracking links and will not disclose your usage habits to third parties.
The source code it runs on is exactly the same as the Github version.
You can also using source code to build your own service if you did'nt trust this service.
## 3. Revisions
The Privacy Policy may be revised at any time. By continuing to use this bot, you continue to agree to the terms of the Privacy Policy.

## Secure
bot does not have any user tracking links and does not disclose your usage habits to third parties. It runs on the same source code as the Github version, so if you think this promise is false, consider building your own service using the source code.

## Revisions
The privacy policy may be modified at any time, if you continue to use this bot, you continue to agree to the terms of the privacy policy.
141 changes: 79 additions & 62 deletions docs/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,108 +2,125 @@
title: Guide
pageClass: guide
---
<!-- translate by deepl -->
# Pixiv bot
A Telegram bot that helps you send pixiv illust on telegeam.
[Get started!](tg://resolve?domain=pixiv_bot&start=67953985) | [Add me to a group](tg://resolve?domain=Pixiv_bot&startgroup=s)
A Telegram bot that helps you send entries from Pixiv in Telegram.
[Click me to start experience](tg://resolve?domain=pixiv_bot&start=67953985) | [Add bot to group](tg://resolve?domain=Pixiv_bot&startgroup=s)


![r_1](./img/r_1.jpg)
! [r_1](. /img/r_1.jpg)


The following Pixiv links are currently supported:
The bot will reply when it matches the following Pixiv link.
- pixiv.net/artworks/:id
- pixiv.net/artworks/en/:id
- pixiv.net/i/:id
- pixiv.net/member_illust.php?illust_id=:id
- pixiv.net/member_illust.php?illust_id=:id#manga
- :id
- :id (that's just plain numbers)

## Simple usage
### message mode
Just send pixiv link to bot
Supports multiple links in one message, just send them all to me!
### Normal message mode
Simply send a pixiv link to bot.
Support multiple links in one message, just send them all to bot!

### inline mode
bot supports Telegram's inline mode, click the share button or [@Pixiv_bot](https://t.me/Pixiv_bot) in the chat to experience it.
At the moment, inline only has the function of daily ranking and illust id, there is no search function yet.
bot supports Telegram inline, click the share button or [@Pixiv_bot](https://t.me/Pixiv_bot) in the chat window to experience it.
Currently, inline only has a daily chart and id search function, but not a direct search function.

> This needs to be filled in! (Only member accounts can have popularity sorting, but it's on hold for now.)
## Advanced Usage
The bot supports some custom usage, here is the introduction of usage.
For example, if I want to show the tag of my work in the reply, then I type `+tag` and it will be shown.
If I don't want the open button, then I type `-open` and the open button disappears.
### persistent save configuration
Use `/s` followed by the configuration
The bot supports some custom configurations.
Simply put, customizing the configuration is to type a few more words to pass the parameters when sending the work, for example, if I want to show the tag of the work in the reply, then type `+tag` and it will be shown.
If you don't want the open button, type `-open` and the open button disappears.

### Persistent save configuration
(This was supposed to be a web version, but the web version hasn't been patched yet)
Use `/s` followed by the configuration
For example:
```
``
/s +tags -share
```
Then bot will default to the `+tags` `-share` configuration for the message / inline
Then the bot will default to `+tags` `-share`.
Set it to a custom configuration (e.g. /s -open -kb ...) After that, you can still manually add `+open` `+kb` etc. to the link / id to display the corresponding content.
#### gives priority to group customization in groups +overwrite
#### Preferred group customization results in groups +overwrite
```
/s +overwrite
```
To overwrite user's customization (for group)
This overrides the individual customized results (for groups).
If you want to output your own formatted message in a group, send it with `+god` every time.
> For persistent configurations, use `/s -overwrite`
> instead of `/s +god`!
### Show series on demand
In a nutshell.
! [r_2](... /img/r_2.jpg)
Description:
- `open` Controls whether the open button is displayed.
- `share` Controls whether the share button is displayed.
- `kb` Controls both the open and share buttons.
> kb = keyboard
- `cp` `rm` Controls whether to add a description to an image.
> `+sc` Add descriptions to multiple images, only the first one.
- `+above` show_caption_above_media
For example:
- `+open -share` Show the open button but not the share button.
If you still want to export your own formatted links in the group, send illust's links with `+god`.
### Include work tags +tags
Just type `+tag` / `+tags` in the message to show the tags of your work.
> Due to Telegram's limitation, the work tags will not become clickable links when some special characters are encountered (e.g. `() - ・)), which means I can't fix it.
### Support for reading links in captions +caption
The `+caption` bot can read the link to the Pixiv work in the caption of a message.
### Exporting works in reverse order +desc
The exported work will be in the reverse order of the input links (multip does not affect)
Example:
Input:
### Include caption tags +tags
Just type `+tag` / `+tags` in the message to show the tags of the work.
> Due to Telegram's limitation, the tags will not be recognized as clickable links when encountering some special characters (e.g. "() - ・), I have no solution for this.
### Add a mask to an image +sp
Typing `+sp` bot adds a spoiler effect to the sent image.
> Inline still doesn't work due to Telegram issues.
### Send work as a file +file
Type `+file` and bot will send you the original file directly.
> and `/s +file` then bot will send you the original file every time.
> For those of you who have the original image in your collection (right-click on a web page to download it faster?).
Type `+af` `+appendf` and bot will send you the original file after sending the image.
> Also supports persistent configuration
### Output works in reverse order +desc
Output works will be in reverse order of the input links (multi-p does not affect)
For example:
Input: illust 1 link
- illust 1 link
- illust 2 link
Return:
Returns: illust 2's image 1
- illust 2's image 1
- illust 1's image 1
- illust 1's image 2
### Show series on demand -open -share -kb -cp -rm
One image summarizes.
! [r_2](./img/r_2.jpg)
Description.
- `-open` does not show the open button
- `-share` does not show the share button
- `-kb` Both open and share buttons are not displayed
> kb = keyboard
- `-cp` does not show the text in the picture
- `-rm` Show only the picture

set to default (/s -open ...) You can still manually add `+open` or something like that to the end of the work to display the corresponding content
### Sending work as a file +file

Enter `+file` and the bot will send you the source file directly.
> and `/s +file` then the work sent to the bot will be sent directly to you every time
### Integrate multiple artworks into one media group (album) +album (enabled by default)

Enter `+album` in the message and the bot will integrate multiple entries into one media group
If you need to disable this feature and send once to an id, then enter `-album` and you're done
> The order of sending pictures may change after `-album` is turned on, and the multi-p works will still be in the media group.
> Also, Telegram has a limit of 10 images in a media group, so it will still send them in separate groups.
### Integrate multiple creations into one media group (album) +album / +one (enabled by default)
Type `+album` / `+one` in the message and the bot will integrate multiple works into one mediagroup.
If you want to disable this feature and send it once for each id, then type `-album`.
After > `-album` the order of posting may change a bit, and multiples will still be in the mediagroup.
### Use telegraph to display +graph +telegraph for multiple entries
Also Telegram has a limit of 10 images in a mediagroup, so it will still be sent in p's.
> `+equal` When bot sends more than 10 images at a time, it tries to equalize the number of images in the mediagroup, e.g. if there are 16 images, it will send 8 images in 2 batches.
Type `+graph` / `+telegraph` in the message and the bot will integrate multiple entries into one telegraph and return a telegraph link for a quick preview on your phone.
### Use telegraph to display multiple entries +graph +telegraph
Type `+graph` / `+telegraph` in the message and the bot will integrate multiple works into a single telegraph and return a link to the telegraph, which can be quickly previewed by your phone.
> If there are too many graphs, Telegram may not show IV instant previews, it is recommended to have less than 200 at a time.
> If you have too many telegraphs, Telegram may not show instant preview in messages, so it's recommended to have less than 200 telegraphs at a time.
It's recommended to have less than 200 telegraphs at a time. ~~If there are too many, my potato server might go down qaq~~!
#### Customize the title, author name and author link in the telegraph link
Example:
For example:
```
https://www.pixiv.net/artworks/91105889 +telegraph
title=白スクのやつ
title=Shirakanoyatsu
author_name=syokuyou-mogura
author_url=https://www.pixiv.net/users/579672
```
format, everything after the = sign will be matched, separated by a new line
![telegraph custom](./img/telegraph-1.jpg)




! [telegraph custom](... /img/telegraph-1.jpg)
10 changes: 6 additions & 4 deletions docs/s.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ title: Bot's configuration
<blockquote>
Here you can customize the bot's return message format
<br>
Here please make sure that your custom format is not too long, messages that are too long will not be sent.
Please pay attention to the number of words in your customized text format, messages that are too long will not be sent.
</blockquote>
<div id="template">
<p style="text-align: center;">Default template (click to apply)</p>
Expand Down Expand Up @@ -54,7 +54,7 @@ title: Bot's configuration
<span class="container" v-html="format(current_template)"></span>
</div>
<div class="custom-block danger">
<p>to show = * _ * []() character, please escape it (\# , \( , \[)), otherwise Telegram will report an error.</p>
<p>Note that to display = * _ * []() please escape before it (\# , \( , \[), otherwise Telegram will report an error when sending the work!</p>
</div>
<div class="textareacard">
<textarea v-model="current_template"></textarea>
Expand All @@ -77,7 +77,7 @@ title: Bot's configuration
<br>
example: <code>%link:|url|?233%</code> -> link: https://www.pixiv.net/artworks/123?233
<br>
if you like |, just add | in front of it to escape it
if you like |, just add \ in front of it to escape it
<br>
<code>%link:\||url|\|?233%</code> -> link:| https://www.pixiv.net/artworks/123|?233
<br>
Expand All @@ -91,7 +91,9 @@ title: Bot's configuration
<br>
<code>%tags%</code> illust's tags
<br>
<code>%NSFW%</code> No safe fork work!
<code>%NSFW%</code> No safe for work!
<br>
<code>%AI%</code> AI work or not
<br>
<code>%author_id%</code> author's id
<br>
Expand Down
2 changes: 1 addition & 1 deletion docs/zh-hans/privacy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar: false

### 用户 id
当您在使用本 bot 的时候，您的 Telegram id 可能会被 bot 记录以及关联。
会触发记录用户 id 的操作目前有以下几个：
会记录用户 id 的操作目前有：

- 自定义回复格式
- 生成 telegraph 页面
Expand Down
Loading

0 comments on commit 3f43dd7

Please sign in to comment.