From a24e3da4ef106397a2a7df9dd5d0e4765caa0d8f Mon Sep 17 00:00:00 2001 From: Victor Westerlund <35688133+VictorWesterlund@users.noreply.github.com> Date: Sun, 15 Nov 2020 16:42:10 +0100 Subject: [PATCH] Update README.md Added some useful information. README is still in early draft, but it's something. --- README.md | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7a2312f..0ad8127 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ -# labylib-animated-textures -Animated textures for Labymod. This is a sample program for VictorWesterlund/labylib +# 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! + +## 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 +```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/`. +``` +~/animated-textures/cape/coolCape-1.png +~/animated-textures/cape/coolCape-2.png +~/animated-textures/cape/coolCape-3.png +... +``` +2. Run `start.py` from a Python 3.x.x CLI +```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)