Update README

Changed some wording and removed a few unnecessary instructions (already provided in the CLI guide)
This commit is contained in:
Victor Westerlund 2020-11-22 20:44:09 +01:00 committed by GitHub
parent a24e3da4ef
commit 28bf9029ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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/<cosmetic>`.
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 <kbd>⏎ Enter/Return</kbd>
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 <kbd>⏎ Enter/Return</kbd>
5. Type `n` and/or press <kbd>⏎ Enter/Return</kbd> to skip advanced configuration.
6. That should be it! Type `y` and/or press <kbd>⏎ Enter/Return</kbd> to start
...
7. To exit the program, Type `stop` and/or press <kbd>⏎ Enter/Return</kbd> (<kbd>Ctrl</kbd>+<kbd>C</kbd> 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)__