From 61ec53f03a87b415fd6c624ef53e1a67a5a38ad0 Mon Sep 17 00:00:00 2001 From: mrmangohands Date: Tue, 5 Jan 2021 21:25:05 -0800 Subject: [PATCH] change: Update README to reflect that these are unofficial ports --- README.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index b0da6e34..6cd73b72 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ ![Project icon](https://git-assets.jellysquid.me/hotlink-ok/phosphor/icon-rounded-128px.png) -# Phosphor (for Fabric) -![GitHub license](https://img.shields.io/github/license/jellysquid3/phosphor-fabric.svg) -![GitHub issues](https://img.shields.io/github/issues/jellysquid3/phosphor-fabric.svg) -![GitHub tag](https://img.shields.io/github/tag/jellysquid3/phosphor-fabric.svg) -[![Discord chat](https://img.shields.io/badge/chat%20on-discord-7289DA)](https://jellysquid.me/discord) -[![CurseForge downloads](http://cf.way2muchnoise.eu/full_372124_downloads.svg)](https://minecraft.curseforge.com/projects/phosphor) +# Phosphor Ports (for Fabric) +![GitHub license](https://img.shields.io/github/license/mrmangohands/phosphor-fabric.svg) +![GitHub issues](https://img.shields.io/github/issues/mrmangohands/phosphor-fabric.svg) +![GitHub tag](https://img.shields.io/github/tag/mrmangohands/phosphor-fabric.svg) Phosphor is a free and open-source Minecraft mod (under GNU GPLv3) aiming to save your CPU cycles and improve performance by optimizing one of Minecraft's most inefficient areas-- the lighting engine. It works on **both the client and server**, and can be installed on servers **without requiring clients to also have the mod**. @@ -13,17 +11,12 @@ It works on **both the client and server**, and can be installed on servers **wi The mod is designed to be as minimal as possible in the changes it makes, and as such, does not modify the light model or interfaces of vanilla Minecraft. Because of this, Phosphor should be compatible with many Minecraft mods (so long as they do not make drastic changes to how the lighting engine works.) If you've ran into a compatibility problem, please open an issue! -### Downloads - -You can find downloads for Phosphor on either the [official CurseForge page](https://www.curseforge.com/minecraft/mc-mods/Phosphor) -or through the [GitHub releases page](https://github.com/jellysquid3/Phosphor-fabric/releases). Usually, builds will be -made available on GitHub slightly sooner than other locations. +These are unofficial ports of [JellySquid and PhiPro's original mod](https://github.com/jellysquid3/phosphor-fabric) to versions +that aren't maintained or present upstream. 1.16.1 is the current priority. -### Community +### Downloads -If you'd like to get help with the mod, check out the latest developments, or be notified when there's a new release, -the Discord community might be for you! You can join the official server for my mods by clicking -[here](https://jellysquid.me/discord). +You can find downloads on the [GitHub releases page](https://github.com/mrmangohands/Phosphor-fabric/releases). --- @@ -51,8 +44,10 @@ or the path to it. The initial setup may take a few minutes. After Gradle has finished building everything, you can find the resulting artifacts in `build/libs`. +Warning, I will likely be force pushing updates. + --- ### License -Phosphor is licensed under GNU LGPLv3, a free and open-source license. For more information, please see the [license file](https://github.com/jellysquid3/phosphor-fabric/blob/1.16.x/dev/LICENSE.txt). +Phosphor is licensed under GNU LGPLv3, a free and open-source license. For more information, please see the [license file](https://github.com/mrmangohands/phosphor-fabric/blob/1.16.x/dev/LICENSE.txt).