From 1cefe8380cfe8942bfee99c4520b33d52679a413 Mon Sep 17 00:00:00 2001 From: Clair Delafuente Date: Mon, 18 Aug 2025 15:08:01 -0400 Subject: [PATCH] Populate README with actual instructions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index e69de29..46f8dac 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,12 @@ +# Clair's AppSettings Archiver +I was asked to make an AppSettings archiver, so this should work as a rough attempt ... for now. + +# How to install +Copy `config.example.py` to `config.py`. Configure your destination directory, and your ROBLOSECURITY cookie if you wish to provide one. I would recommend using an alternate Roblox account, mostly out of precaution. Your ROBLOSECURITY is not transmitted to any other place than Roblox with this script. + +This project uses [Poetry](https://python-poetry.org/), which has very clear documentation on how to install it: +1. `pip install pipx` to install PIPX +2. `pipx install poetry` to install Poetry under PIPX (You will have global access to Poetry, PIPX performs some gnarly isolation while still allowing global access to tools) +3. In this directory, run `poetry install`. This will install all dependencies required by AppSettings-archiver + +At this point, execute `poetry run __init__.py`. This should run AppSettings-archiver, archive all AppSettings channels, and then immediately exit. Your results will be in DST_DIR (by default, 'AppSettings' in the working directory) \ No newline at end of file