How To

Home App Guide


To search in the rentry with keywords (on computer):

  • On Windows: CTRL + F
  • On Mac: Command + F


Configure the LLM

You can check this page for a step-by-step with every available model.

Change appearance of the app

You can currently:

  • Toggle the background image ON/OFF
  • Blur/unblur NSFW pictures (Android only)
  • Toggle between light and dark mode
  • Change font size
  • Change the colors

From your profile

  1. Tap on your profile picture
  2. Hit 'profile'.
  3. Hit 'Edit theme'.
  4. Edit the appearance as you wish.

Change appearance profile

From the chat

  1. In chat, tap on the three dots on the left of the typing field
  2. Hit 'Change Theme'.
  3. Edit the appearance as you wish.

Change appearance chat

Change the background image of my chat

Only the owner of the card can set a background image. The background image will be the same for all users who enabled the option.

Set a background image

  1. On the character card (the main page, not the edit), go to the gallery
  2. Add a picture
  3. Pin the picture

Add a background image

Use personas

What is a persona?

A persona is you. Or at least, the character you are impersonating. That's how the bot will know who you are. You want to keep it short, that's not a character card. A persona too long can actually make the bot act as you. Try to only describe the things the bot would know at first glance, the things which are widely known. Personality is not necessary, since you will give the personality yourself during the chat.

More explanations about what a persona is and how to make one here.

Set up a persona

  1. In chat, tap on the three dots on the left of the typing field
  2. Hit 'Persona'.
  3. Add a persona
  4. Edit your persona if you haven't yet. (Remember to save the changes)
  5. Select your persona in the dropdown menu.
  6. Save.

Set up persona

Use group chats

Set up group chats

  1. Tap on the three lines on the top right corner of your chat window.
  2. Select 'chat settings'.
  3. Type the name of your character in the field. It will populate automatically. (If there are too many choices, use the path of the character you want to use or character's name + author's name).
  4. Select your character.
  5. Save.

Path Group Chat

Set up group chats

Use group chats

  • By default, the characters will alternate between them with your messages (eg: character 1 ⇾ you⇾ character 2 ⇾ you ⇾ character 1)
  • You can force one character to answer by selecting which one on the picture on the right of the typing field.
  • Typically, after a you select the same character a couple of times in a row, it will automatically be the only one answering you (eg: character 1 ⇾ character 2 ⇾ you ⇾ character 2 ⇾ you ⇾ character 2).
  • Changing the character acts like the 'send' button.
  • When you send a prompt, only the definition of the character you selected will be sent, not all the definitions.

Use lorebooks

What is a lorebook?

A lorebook is like an encyclopedia of the things your character needs to know. For more informations about how to use and create a lorebook, you have great resources here. The most complete one is this guide.

Set up a lorebook

!!! For all types of lorebooks, be sure to activate the use of lorebooks in your Configuration !!!

  1. Tap on the three lines on the top right corner of your chat window.
  2. Select 'Configuration'.
  3. Select 'Prompt Structure'.
  4. Scroll down and toggle on 'Use Lorebooks'.
  5. Save.

Activate lorebooks

For reference, this is the part of the URL needed to link a lorebook:

Path lorebook

Embedded

An embedded lorebook is a lorebook used by only one character, embedded in the character card. Meaning that, if you download it, the lorebook will be downloaded too. The lorebook will stay across chats and users.

  1. In your character's editor, hit 'Add an embedded lroebook'. Create your lorebook.
  2. Hit 'Create character' or 'Update character'.

Lorebook embedded

Linked to the character card

You can create a lorebook separately, and then link it to the character. This option is good if you want to use one lorebook for multiple characters and be able to update it for all at the same time. The lorebook will stay across chats and users.

  1. In your character's main page, go to 'lorebooks'.
  2. Hit 'link a lorebook'.
  3. Paste the path of your lorebook.
  4. Tap on 'Add lorebook'.

Lorebook linked to character

Linked to the chat

You can create a lorebook separately, and then link it to the chat. This option is good if you want to use a lorebook for a conversation, without using it everytime you have a chat with your character. The lorebook will NOT stay across chats and users.

  1. Tap on the three lines on the top right corner of your chat window.
  2. Select 'chat settings'.
  3. Add the path of your lorebook.
  4. Hit 'Add lorebook'.
  5. Save.

Lorebook linked to chat

Linked to persona

You can create a lorebook separately, and then link it to a persona. This option is good if you want to add background informations about your persona without bloating the persona itself.

  1. In chat, tap on the three dots on the left of the typing field
  2. Hit 'Change persona'.
  3. Hit the pen.
  4. Paste the path of the lorebook.
  5. Tap on 'Add lorebook'.
  6. Tap on 'Update persona'.

Lorebook linked to persona

Set up TTS (Text To Speech) with 11Labs

API key

  1. Tap on the three lines on the top right corner of your chat window.
  2. Select 'Secrets'.
  3. Select 'ElevenLabs'.
  4. Put your API key.
  5. Check your API key.

API key 11labs

Settings

  1. Tap on the three lines on the top right corner of your chat window.
  2. Select 'Configuration'.
  3. Select 'Text-To-Speech'.
  4. Select '11labs' in the 'API' dropdown menu.
  5. Select the model in the 'model' dropdown menu.
  6. Select the voice in the 'voice' dropdown menu.
  7. Save.

TTSwith11Labs

Turn on/off Auto-summarization

  1. Tap on the three lines on the top right corner of your chat window.
  2. Select 'Configuration'.
  3. Select 'Prompt Structure'.
  4. Scroll down and toggle 'Auto summarization'.
  5. Save.

Auto summarization OFF

Use Mars/Mercury on SillyTavern

Get the API key and the URL

You need to have an active subscription.

  1. Hit your profile picture
  2. Hit 'Subscription'
  3. Copy the URL of the model you want to use (depending on your subscription)
  4. Hit 'New Token'
  5. Tap the key to copy it

With Mars, you can also use this URL to have access to all the available models directly: https://mars.chub.ai/v1

Get API key

Set up the API

  1. Access the API settings
  2. Select 'Chat Completition' in the 'API' dropdown menu
  3. Select 'Custom (OpenAI-compatible) in the 'Chat Completition Source' dropdown menu
  4. Paste your URL
  5. Paste your key (token)
  6. Hit 'Connect'
  7. Ìf you used https://mars.chub.ai/v1, select your model

Set up key on ST

Use the search function

See latest cards

Like you may have noticed, there isn't a 'Latest' option anymore. It has been taken off the home page to give the tag moderators more time to moderate the new cards, since some cards may be triggering and would be blocked for some users if they were correctly tagged. You can still see the latest cards, it's just a bit more difficult, and they may not be correctly tagged yet.

  1. Tap on the filter.
  2. Open the 'Sort by' dropdown menu.
  3. Select 'Creation time'.

Latest

Use the filters

The numbers are to make it easier to understand. There isn't any order.

  1. Add the tags you want to include
  2. Don't check the box if you only want cards with all the tags. Check the box if you want cards with only some of the tags.
  3. Add the tags you want to exclude.
  4. Select how you want to sort your results
  5. Select if you want to sort your results from the biggest/latest to the smallest/earliest, or the other way.
  6. Check the boxes if you only want cards with this attribute.

Use filters

Use macros / markers

Works

{{char}}

Will be replaced by your character's name.

{{user}}

Will be replaced by your persona's name

{{original}}

In the character card's Pre and Post History, will be replaced be the Pre and Post history from the user's API settings.

<START>

In the example dialogs, is used to start a new example.

Doesn't work

{{char1}}, {{char2}}, etc.

Usually used in group chats and multiple charcter bots. No, it doesn't get replaced by the name of any character.

END_OF_DIALOG

Usually used to mark the end of an example message. No, it doesn't work.

Create a New Preset

What is a preset ?

A preset is a premade set of prompt and generation parameters. You can use them when you often change model/settings.

New preset

  1. Tap on the three lines on the top right corner of your chat window.
  2. Select 'Configuration'.
  3. Check if the 'Search for a Preset by name' dropdown menu is empty. If not, hit the red cross next to the preset's name.
  4. Set your Prompt Structure
  5. Set you Generation Settings
  6. Hit 'Make New Preset from Current Settings'
  7. Save

New Preset

Use images in chat

The image model is a separate model from text generation.

Send images

  1. In chat, tap on the three dots on the left of the typing field
  2. Tap on "Send image"

After sending the image, a description is generated by the model. You can see it and edit it as you wish by pressing the "edit" button of the message with the picture.

Send image

Generate images

  1. In your writing field, use the command /imagine
  2. Write your prompt
  3. If there is something you don't want to see, you can use: --no <something>
  4. If you want to use a particular seed, you can use: --seed <a number between 0 and 4294967295>
  5. Send.

imagine

Edit Report
Pub: 07 Jun 2024 22:28 UTC
Edit: 01 Dec 2024 11:31 UTC
Views: 4200