Code Monkey home page Code Monkey logo

labylib-chattycape's Introduction

Chattycape Demo

Chattycape

This labylib extension updates your LabyMod cape with tags from Minecraft chat.

Get Started

IMPORTANT:

Chattycape overwrites your current LabyMod cape; so make sure to save it before you begin.

  1. Login and open the LabyMod Dashboard
  2. Under the "YOUR COSMETICS" section, click the tiny image of your cape
    Step 1
  3. Right-click the image and select "Save image as.."
    It's called the same in other major browsers. (Screenshot of Chrome) Step 2

Installation

  1. Download the latest version of Chattycape
  2. Download and install the latest version of Python 3 for your architecture
  3. Install labylib with pip
$ python3 -m pip install labylib

or if that doesn't work..

$ pip3 install labylib

Usage

  1. Run start.py with python3 (not as root)
$ python3 start.py
  1. Chattycape CLI will now ask you to provide additonal details.

and here's an explanation of them all in order:

Input Description
Path to your '.minecraft'-folder: Only appears if your Minecraft-installation couldn't be located automatically.
Enter a full (absolute) path to your .minecraft-folder. Example: "C://Users/VicW/AppData/Roaming/.minecraft"
Cape render endpoint [https://api.victorwesterlund.com/chattycape]: Paste a custom render enpoint URL here, or press enter to use the default.
My Minecraft in-game name (Case Sensitive) [Don't exclude me]: Enter your Minecraft IGN to exclude yourself from tagging or press enter to allow messages from yourself
PHPSESSID cookie: Here's what it is and where to find it
  1. That's it. You should now see this at the end of your terminal:
    Terminal

  2. When you want exit: Press โŽ Enter / โŽ Return to close

Default Behavior

If you start Chattycape with the default render endpoint; https://api.victorwesterlund.com/chattycape - your cape will update every 15 seconds (limit) with a graphic of the player avatar, name and tag (usually "rank") who last said something in public chat (See collage at the start of this document). It only works on a handful of servers at the moment, more can be added in the future.

Custom Render Endpoint

Chattycape works best when creative people like yourself come up with their own templates!

Chattycape CLI prompts the user upon every start, if they want to use a custom render endpoint. What this means is that you could easily create your own "texture generator" in whatever language you want, as long as the output is a type image/png and satisfies LabyMod's sprite layout:
Layout

  • Chattycape makes a request to the endpoint every 15 seconds (limit) with the URLParams server, username and tag.
    Example from default endpoint:
https://api.victorwesterlund.com/chattycape?server=us.mineplex.com&username=VicW&tag=immortal
URLParam Value
server IP/Hostname of current server.
username Case-Sensitive string of Minecraft IGN.
tag String typecasted to lowercase containing a filtered tag.
Default behavior: Extracts player rank on supported servers.
  • URLParam value will be assigned None for falsy conditions. This includes if a player is unranked (tag not found)

Contribute

If you find any bugs or would like to suggest features, please submit it as an Issue.

Pull requests to this repo are more than welcome!

License

GNU General Public License v2.0

labylib-chattycape's People

Contributors

victorwesterlund avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.