Skip to content

Commit

Permalink
Grammar in README 😢
Browse files Browse the repository at this point in the history
  • Loading branch information
Tumpa-Prizrak authored Jan 29, 2024
1 parent 30fa89b commit 130b73b
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Cai tools

> [!CAUTION]
> This project violates [Crush on AI ToS](https://crushon.ai/terms-of-service). Using it can lead it your account been banned! You have been warned and I am not responsible for this.
> This project violates [Crush on AI ToS](https://crushon.ai/terms-of-service). Using it can lead it your account being banned! You have been warned and I am not responsible for this.
> [!WARNING]
> This project is not finished yet, so some things in the README may appear later
Expand All @@ -10,20 +10,20 @@
> You can ignore "Requirements" and "Installation" blocks by downloading executables on the [Release tab](https://github.com/Tumpa-Prizrak/cai-tool/releases)
> [!NOTE]
> Installation guide is written for linux users. Windows are pretty similar, but google steps that's outputting an error
> Installation guide is written for Linux users. Windows is pretty similar, but google steps that is outputting an error
Cai stands for [Crush on AI](https://crushon.ai/). This tool will help you with managing your Favorite characters in CRUD: create, read, update and delete
Cai stands for [Crush on AI](https://crushon.ai/). This tool will help you with managing your Favorite characters in CRUD: create, read, update, and delete

> [!NOTE]
> `ChatGPT tl;dr` This project provides a tool to manage your favorite characters on Crush on AI platform. However, using it violates Crush on AI's terms of service and can lead to account banning. The tool requires Python 3.9+. You can download executables from the Release tab to avoid installation steps. The tool allows CRUD operations on your favorite characters and is accessible via shell or terminal only. The README provides instructions on how to install and use the tool, including commands for parsing, removing, and randomly selecting a character.
> `ChatGPT tl;dr` This project provides a tool to manage your favorite characters on Crush on the AI platform. However, using it violates Crush on AI's terms of service and can lead to account banning. The tool requires Python 3.9+. You can download executables from the Release tab to avoid installation steps. The tool allows CRUD operations on your favorite characters and is accessible via shell or terminal only. The README provides instructions on how to install and use the tool, including commands for parsing, removing, and randomly selecting a character.
## Requirements

- `Python 3.9+`

## Installation

- Copy project and create virtual environment
- Copy the project and create a virtual environment

```sh
git clone https://github.com/Tumpa-Prizrak/cai-tool.git
Expand All @@ -38,8 +38,8 @@ source venv/bin/activate
pip install -r requirements.txt
```

- Change *root_folder* variable in `config.py` to your home folder or other directory that contains `cai` directory - place where utility will save it's OC database.
- Change directories at `cai` file to place with `main.py` script in it.
- Change the *root_folder* variable in `config.py` to your home folder or another directory that contains the `cai` directory - a place where the utility will save its OC database.
- Change directories at the `cai` file to place with the `main.py` script in it.
- Allow execution of the `cai` file

```sh
Expand All @@ -53,18 +53,18 @@ chmod +x cai
```

> [!TIP]
> You can copy `cai` file to any directory in your `$PATH` variable. For example to `/usr/bin`. This will make utility available from any directory. Use cp command for this: `sudo cp cai /usr/bin/cai`.
> You can copy the `cai` file to any directory in your `$PATH` variable. For example to `/usr/bin`. This will make utility available from any directory. Use the cp command for this: `sudo cp cai /usr/bin/cai`.
## Usage

See `cai --help` for brief usage. All interactions will be available only using shell or other type of terminal. You can't use this via UI
See `cai --help` for brief usage. All interactions will be available only using a shell or other type of terminal. You can't use this via UI

> [!NOTE]
> This utility don't manage your real data at CAI platform - it's on your local PC only. Util there's no public API available - it's impossible to implement
> This utility doesn't manage your real data on the CAI platform - it's on your local PC only. Util there's no public API available - it's impossible to implement
### First using

Create `plaintext.txt` file in your `cai` directory. Go to your [Favorite characters page](https://crushon.ai/account) (Profile -> Interactions -> Favorite characters). Press `Ctrl + A` to highlight text of the webpage and `Ctrl + C` to copy all highlighted text. Then paste it to `plaintext.txt`. Run `cai parse`
Create a `plaintext.txt` file in your `cai` directory. Go to your [Favorite characters page](https://crushon.ai/account) (Profile -> Interactions -> Favorite characters). Press `Ctrl + A` to highlight the text of the webpage and `Ctrl + C` to copy all highlighted text. Then paste it to `plaintext.txt`. Run `cai parse`

### Parse

Expand All @@ -76,12 +76,12 @@ cai parse

#### Description

Parse command parse your `plaintext.txt` for characters and saves them to `ocs.json` for later use. You should run this command every time you change your `plaintext.txt` file. Match number of characters parsed with your Favorite character amount. If it isn't match - create issue at [Github Issues page](https://github.com/Tumpa-Prizrak/cai-tool/issues) with your "plaintext.txt" file attached, probably something wrong with script
The parse command parses your `plaintext.txt` for characters and saves them to `ocs.json` for later use. You should run this command every time you change your `plaintext.txt` file. Match the number of characters parsed with your Favorite character amount. If it doesn't match - create an issue at [Github Issues page](https://github.com/Tumpa-Prizrak/cai-tool/issues) with your "plaintext.txt" file attached, probably something wrong with the script

#### Errors

- **plaintext.txt is not found! Did you created it?** - make sure you created `plaintext.txt` and changed directory at `config.py` file. Directory must always contain `plaintext.txt`
- **No characters found! Did you filled up plaintext.txt?** - make sure you filled up `plaintext.txt` with data you copied from "Favorite characters". Otherwise - create issue at [Github Issues page](https://github.com/Tumpa-Prizrak/cai-tool/issues) with your "plaintext.txt" file attached, probably something wrong with script
- **plaintext.txt is not found! Did you create it?** - make sure you created `plaintext.txt` and changed the directory in a `config.py` file. The directory must always contain `plaintext.txt`
- **No characters found! Did you fill up plaintext.txt?** - make sure you filled up `plaintext.txt` with data you copied from "Favorite characters". Otherwise - create an issue at [Github Issues page](https://github.com/Tumpa-Prizrak/cai-tool/issues) with your "plaintext.txt" file attached, probably something wrong with the script

### Random

Expand All @@ -93,20 +93,20 @@ cai random

#### Description

Random command choose random character from your library and output all the info about it:
Random command choose a random character from your library and output all the info about it:

- id - position of the character in the list
- messages - approximate amount of total messages. Example: *\~ 2000 msg*
- memories - amount of memories with this character
- name - name of this character
- messages - the approximate amount of total messages. Example: *\~ 2000 msg*
- memories - the amount of memories with this character
- name - the name of this character
- by {author} - author of this character
- description - brief description of the character
- tags - list of the tags of the character, categorizing it. Example: *NSFW, Elf, Submissive, Kinky, Seductive, Female*

#### Errors

- `No OCs found! Did you filled plaintext.txt?` - make sure you filled up `plaintext.txt` with data you copied from "Favorite characters" and then used "cai parse"
- `No parsed OCs found! use cai parse` - File `ocs.json` is not found. Run `cai parse` command before using this command
- `No OCs found! Did you fill plaintext.txt?` - make sure you filled up `plaintext.txt` with data you copied from "Favorite characters" and then used "cai parse"
- `No parsed OCs found! use cai parse` - File `ocs.json` is not found. Run the `cai parse` command before using this command

### Remove

Expand All @@ -121,12 +121,12 @@ cai remove --id <integer> --name <string>

#### Description

Removes character based on it's id or name.
Removes character based on its id or name.

- Character id - position of the character in the list. Usually you get it via using `cai random` command. Press **Enter** to confirm deletion or **N** and then **Enter** to cancel it
- Name - name of the character. utility is using indirect comparison so you'll be able to find your character even without one in one match. Press **Enter** to see next character, press **Y** and then **Enter** to delete character.
- Character id - position of the character in the list. Usually, you get it by using the `cai random` command. Press **Enter** to confirm deletion or **N** and then **Enter** to cancel it
- Name - name of the character. utility is using indirect comparison so you'll be able to find your character even without one in one match. Press **Enter** to see the next character, press **Y**, and then **Enter** to delete a character.

#### Errors

- `No OCs found! Did you filled plaintext.txt?` - make sure you filled up `plaintext.txt` with data you copied from "Favorite characters" and then used "cai parse"
- `No parsed OCs found! use cai parse` - File `ocs.json` is not found. Run `cai parse` command before using this command
- `No OCs found! Did you fill plaintext.txt?` - make sure you filled up `plaintext.txt` with data you copied from "Favorite characters" and then used "cai parse"
- `No parsed OCs found! use cai parse` - File `ocs.json` is not found. Run the `cai parse` command before using this command

0 comments on commit 130b73b

Please sign in to comment.