Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 1.93 KB

README.md

File metadata and controls

67 lines (49 loc) · 1.93 KB
Raw

Lore Cleaner

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

Authors / Contributors

@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

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: 
    [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

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