clair/AppSettings-archiver
1
0
Fork 0
Code Activity

Populate README with actual instructions

Browse Source
This commit is contained in:
Clair Delafuente
2025-08-18 15:08:01 -04:00
parent 4cc1ff7620
commit 1cefe8380c
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -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)