syorito-hatsuki/bluemap-custom-skin-server

Simple addon for BlueMap that allows using a custom skin server.

Bluemap Custom Skin Server

BlueMap addon that allow to use custom skin server
Support · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Usage
   • Config
3. Roadmap
4. Contributing
5. License

About The Project

Built With

• 
• 
• 
• 
• 

(back to top)

Usage

Config

{
  // Server type [ MOJANG_LIKE | CUSTOM ]
  "serverType": "CUSTOM",
  // Direct image mean that image not going to be cut or resized.
  // That allow you to use APIs that return player head only
  "directImage": false,
  // URL to remote server. Use %uuid% and/or %username% placeholders where required
  "url": "https://localhost/%uuid%/%username%",
}

Before 2024.5.1

{
  // Debug mode for issue or self error search 
  "debug": false,
  // Server type [ MOJANG_LIKE | CUSTOM ]
  "serverType": "CUSTOM",
  // URL to remote server. Added %uuid% and/or %username% placeholders where required
  "url": "https://localhost/%uuid%/%username%",
}

Before 2023.11.1

{
  // Debug mode for issue or self error search 
  "debug": false,
  // Server type [ MOJANG_LIKE | CUSTOM ]
  "serverType": "MOJANG",
  // Here u must put custom link. Examples u can see below
  "customSkinServerUrl": "https://localhost/",
  // This params supported only by CUSTOM server type
  "custom": {
    // Text after username in request url. As example for https://mcskins.top/ need ".png"
    "suffix": "",
    // Type of search param [ NAME | UUID ]
    "getSkinBy": "NAME",
    // Name case [ LOWER | UPPER | DEFAULT ]. As example for https://mcskins.top/ need LOWER
    "skinByCase": "LOWER"
  }
}

(back to top)

Roadmap

• Change link format

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)