From 28bf9029ad712d23c81d83bc869a5b10644c5360 Mon Sep 17 00:00:00 2001 From: Victor Westerlund <35688133+VictorWesterlund@users.noreply.github.com> Date: Sun, 22 Nov 2020 20:44:09 +0100 Subject: [PATCH] Update README Changed some wording and removed a few unnecessary instructions (already provided in the CLI guide) --- README.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0ad8127..808bb1b 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,16 @@ -# Labylib - Animated Textures -Animated textures for Labymod. - -This is a sample program for VictorWesterlund/labylib - -[Supported Labymod cosmetics](https://github.com/VictorWesterlund/labylib#supported-cosmetics) more coming soon! +# Labylib - Animated Cape +Add GIF-like animations to your LabyMod cape. This script sequentially updates your cape with PNGs from a folder. ## Installation -1. Download and install [Python 3.x.x](https://www.python.org/downloads/) for your computer's architecture -2. Clone this repo to your machine, or [download a zip](/VictorWesterlund/labylib-animated-textures/archive/master.zip) if you don't speak git +1. Download and install [Python 3](https://www.python.org/downloads/) for your computer's architecture +2. Clone this repo, or [download it as a zip](/VictorWesterlund/labylib-animated-textures/archive/master.zip) ```bash $ git clone https://github.com/VictorWesterlund/labylib-animated-textures/ $ gh repo clone VictorWesterlund/labylib-animated-textures ``` -3. Extract/copy the `labylib` folder into your project (or make it a dependancy) ## Quickstart -1. Upload textures to the texture folder(s) found in `~/animated-textures/`. +1. Add textures to the `~/animated-textures/` folder. ``` ~/animated-textures/cape/coolCape-1.png ~/animated-textures/cape/coolCape-2.png @@ -26,9 +21,6 @@ $ gh repo clone VictorWesterlund/labylib-animated-textures ```bash $ python3 start.py ``` -3. The program will ask you if you want to start a guided setup (first time). Type `y` and/or press ⏎ Enter/Return -4. You are now asked to provide a `PHPSESSID`; This is the core-functionality of labylib. [Here's how you locate your `PHPSESSID`](https://github.com/VictorWesterlund/labylib#find-your-phpsessid-cookie). Once you've located your `PHPSESSID`-cookie. Paste it and press ⏎ Enter/Return -5. Type `n` and/or press ⏎ Enter/Return to skip advanced configuration. -6. That should be it! Type `y` and/or press ⏎ Enter/Return to start -... -7. To exit the program, Type `stop` and/or press ⏎ Enter/Return (Ctrl+C a few times to force quit; still in pre-release after all) +3. Follow the CLI step-by-step guide + +__The script will ask you for a `PHPSESSID`, [here's what it is and how to find it](https://github.com/VictorWesterlund/labylib/wiki/Find-your-PHPSESSID)__