Skip to content

Commit

Permalink
Improved Readme & Changed package name
Browse files Browse the repository at this point in the history
  • Loading branch information
TechnicJelle committed Aug 24, 2022
1 parent 91720b7 commit f7624e1
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 5 deletions.
Binary file added .github/readme_assets/with.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/readme_assets/without.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# BlueMap Floodgate
[![GitHub Total Downloads](https://img.shields.io/github/downloads/TechnicJelle/BlueMapFloodgate/total?label=Downloads&color=success "Click here to download the plugin")](https://github.com/TechnicJelle/BlueMapFloodgate/releases/latest)

A Minecraft Paper plugin and [BlueMap](https://github.com/BlueMap-Minecraft/BlueMap) addon that adds https://github.com/GeyserMC/Floodgate support
A Minecraft Paper plugin and [BlueMap](https://github.com/BlueMap-Minecraft/BlueMap) addon that adds [Geyser/Floodgate](https://github.com/GeyserMC/Floodgate) support:
by default, floodgate players don't have the correct playerhead image on BlueMap. This plugin fixes that.

| Without | With |
|----------------------------------------------------------|----------------------------------------------------|
| ![without the plugin](.github/readme_assets/without.png) | ![with the plugin](.github/readme_assets/with.png) |

You can safely reload the config by reloading this plugin with [PlugManX](https://www.spigotmc.org/resources/plugmanx.88135/).\
(I do not recommend using it for other plugins! Plugin reloaders like this can seriously mess up some plugins)
Expand All @@ -11,7 +16,7 @@ You can safely reload the config by reloading this plugin with [PlugManX](https:
- Do not touch this one! It's needed internally to keep track of the config versions.
- `verboseLogging: true`
- Set to `true` if you want more messages telling you what the plugin is up to.
- `useTydiumCraftSkinAPI: true`
- `useTydiumCraftSkinAPI: false`
- Option to choose between using the [TydiumCraft Skin API](https://tydiumcraft.net/docs/skinapi) and my own custom implementation.
- `cacheHours: 72`
- How long to keep the playerheads cached for. The lower this number, the faster skin updates will appear, but the more network usage there will be.
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>net.mctechnic</groupId>
<groupId>com.technicjelle</groupId>
<artifactId>BlueMapFloodgate</artifactId>
<version>1.4.3</version>
<packaging>jar</packaging>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package net.mctechnic.bluemapfloodgate;
package com.technicjelle.bluemapfloodgate;

import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/plugin.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: BlueMapFloodgate
version: ${project.version}
main: net.mctechnic.bluemapfloodgate.main
main: com.technicjelle.bluemapfloodgate.Main
api-version: 1.17
depend:
- BlueMap
Expand Down

0 comments on commit f7624e1

Please sign in to comment.