https://github.com/betawolfy/lorecleaner

Lore cleaner for TFR • Tyrents of False Reality
https://github.com/betawolfy/lorecleaner

Last synced: 10 days ago
JSON representation

Lore cleaner for TFR • Tyrents of False Reality

• Host: GitHub
• URL: https://github.com/betawolfy/lorecleaner
• Owner: Betawolfy
• Created: 2024-12-15T14:54:31.000Z (22 days ago)
• Default Branch: main
• Last Pushed: 2024-12-23T12:21:43.000Z (15 days ago)
• Last Synced: 2024-12-23T12:29:45.643Z (15 days ago)
• Language: Python
• Size: 15.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Lore Cleaner

A simple Python script in order to clean text files containing RP logs.

## Authors / Contributors

[@betawolfy](https://www.github.com/Betawolfy)

## Features

- Removes time (format HH:MM).

- Removes and, optionnaly, replaces names in the cleared log.

- Removes empty lines.

- Can figure out if a line is a action or a dialogue.

- WIP - Can figure out if a name is missing in rules.

- Keeps format and RP special character.

## Installation

```bash

git clone https://github.com/Betawolfy/LoreCleaner

cd lore-cleaner

```

    

## Usage/Examples

1. Place the lore.txt file in the same directory as this script.

2. Add any strings that need to be removed to the remove.txt file

3. Optionnaly, add a footer in footer.txt

4. Run the script using ```python index.py```

5. The cleaned text will be saved to lore_cleaned.txt

## Setups

`lore.txt` - Raw lore. 

`remove.txt` - Specify all rules here.

`footer.txt` - Optionnal, display a custom text at the beginning of the output.

`lore_uncleared.txt` - The output of the dialogue/action detection.

`lore_cleaned.txt` - The output, with all removed times, rules, etc..

## Mendatory format

> [!NOTE]

> Normally, the program can now figure out if a line is a dialogue or an action. As it is still in development, it is recommended that you review manually the output then report any issues to the author.

- The correct format for `remove.txt` is:

  ```txt

  [String to delete]:Optionnal replacement string

  ```

- Story lines must be between [ Brackets ]

- Dialogues lines must begin by d (put a d before time)

#### Exemple: | File: lore.txt

```txt

10:00[{TFR} Adm. Betawolfy] [ This is a Story line]

d10:00[{TFR} Adm. Betawolfy] "This is a dialogue line"

```

## Roadmap

- ~~Planning making it a website.~~ Discontinued for now.

- Making it more user-friendly.

- Making the name detection more accurate.

- Adding more rules.

## Feedback

If you have any feedback, please reach out to me by discord: `betawolfy`