Skip to content

Commit

Permalink
change: Update README to reflect that these are unofficial ports
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmangohands committed Jan 6, 2021
1 parent addcc57 commit 61ec53f
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,22 @@
![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**.

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).

---

Expand Down Expand Up @@ -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).

0 comments on commit 61ec53f

Please sign in to comment.