{"id":15014898,"url":"https://github.com/caffeinemc/phosphor-fabric","last_synced_at":"2025-05-16T08:07:10.210Z","repository":{"id":37298565,"uuid":"251440852","full_name":"CaffeineMC/phosphor-fabric","owner":"CaffeineMC","description":"A Fabric mod designed to dramatically improve the performance of Minecraft's lighting engine while fixing many bugs","archived":false,"fork":false,"pushed_at":"2024-01-28T07:57:01.000Z","size":803,"stargazers_count":1110,"open_issues_count":2,"forks_count":71,"subscribers_count":30,"default_branch":"1.19.x/dev","last_synced_at":"2025-04-27T00:02:06.549Z","etag":null,"topics":["fabric","minecraft"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CaffeineMC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"jellysquid3","patreon":"jellysquid"}},"created_at":"2020-03-30T22:16:22.000Z","updated_at":"2025-04-22T12:24:02.000Z","dependencies_parsed_at":"2024-03-31T22:44:44.875Z","dependency_job_id":null,"html_url":"https://github.com/CaffeineMC/phosphor-fabric","commit_stats":null,"previous_names":["jellysquid3/phosphor-fabric"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CaffeineMC%2Fphosphor-fabric","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CaffeineMC%2Fphosphor-fabric/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CaffeineMC%2Fphosphor-fabric/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CaffeineMC%2Fphosphor-fabric/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CaffeineMC","download_url":"https://codeload.github.com/CaffeineMC/phosphor-fabric/tar.gz/refs/heads/1.19.x/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254493385,"owners_count":22080127,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fabric","minecraft"],"created_at":"2024-09-24T19:46:14.300Z","updated_at":"2025-05-16T08:07:05.201Z","avatar_url":"https://github.com/CaffeineMC.png","language":"Java","funding_links":["https://github.com/sponsors/jellysquid3","https://patreon.com/jellysquid"],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"src/main/resources/assets/phosphor/icon.png\" width=\"128\"\u003e\n\n# Phosphor (for Fabric)\n![GitHub license](https://img.shields.io/github/license/CaffeineMC/phosphor-fabric.svg)\n![GitHub issues](https://img.shields.io/github/issues/CaffeineMC/phosphor-fabric.svg)\n![GitHub tag](https://img.shields.io/github/v/tag/CaffeineMC/phosphor-fabric.svg)\n\nPhosphor 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.\nIt works on **both the client and server**, and can be installed on servers **without requiring clients to also have the mod**.\n\nThe 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\nwith 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!\n\n\n---\n\n## Installation\n\n### Manual installation (recommended)\n\nYou will need Fabric Loader 0.10.x or newer installed in your game in order to load Phosphor. If you haven't installed\nFabric mods before, you can find a variety of community guides for doing so [here](https://fabricmc.net/wiki/install).\n\n#### Stable releases\n\n![GitHub release](https://img.shields.io/github/release/CaffeineMC/phosphor-fabric.svg)\n\nThe latest releases of Phosphor are published to our [Modrinth](https://modrinth.com/mod/phosphor) and\n[GitHub release](https://github.com/CaffeineMC/phosphor-fabric/releases) pages. Releases are considered by our team to be\n**suitable for general use**, but they are not guaranteed to be free of bugs and other issues.\n\nUsually, releases will be made available on GitHub slightly sooner than other locations.\n\n#### Bleeding-edge builds (unstable)\n\n[![GitHub build status](https://img.shields.io/github/workflow/status/CaffeineMC/phosphor-fabric/gradle-ci/1.16.x/dev)](https://github.com/CaffeineMC/phosphor-fabric/actions/workflows/gradle.yml)\n\nIf you are a player who is looking to get your hands on the latest **bleeding-edge changes for testing**, consider\ntaking a look at the automated builds produced through our [GitHub Actions workflow](https://github.com/CaffeineMC/phosphor-fabric/actions/workflows/gradle.yml?query=event%3Apush).\nThis workflow automatically runs every time a change is pushed to the repository, and as such, the builds it produces\nwill generally reflect the latest snapshot of development.\n\nBleeding edge builds will often include unfinished code that hasn't been extensively tested. That code may introduce\nincomplete features, bugs, crashes, and all other kinds of weird issues. You **should not use these bleeding edge builds**\nunless you know what you are doing and are comfortable with software debugging. If you report issues using these builds,\nwe will expect that this is the case. Caveat emptor.\n\n### CurseForge\n\n[![CurseForge downloads](http://cf.way2muchnoise.eu/full_372124_downloads.svg)](https://www.curseforge.com/minecraft/mc-mods/phosphor)\n\nIf you are using the CurseForge client, you can continue to find downloads through our\n[CurseForge page](https://www.curseforge.com/minecraft/mc-mods/phosphor). Unless you are using the CurseForge\nclient, you should prefer the downloads linked on our Modrinth or GitHub release pages above.\n\n---\n\n### Reporting Issues\n\nYou can report bugs and crashes by opening an issue on our [issue tracker](https://github.com/CaffeineMC/phosphor-fabric/issues).\nBefore opening a new issue, use the search tool to make sure that your issue has not already been reported and ensure\nthat you have completely filled out the issue template. Issues which are duplicates or do not contain the necessary\ninformation to triage and debug may be closed.\n\nPlease note that while the issue tracker is open to feature requests, development is primarily focused on\nimproving hardware compatibility, performance, and finishing any unimplemented features necessary for parity with\nthe vanilla renderer.\n\n### Community\n[![Discord chat](https://img.shields.io/badge/chat%20on-discord-7289DA?logo=discord\u0026logoColor=white)](https://caffeinemc.net/discord)\n\nWe have an [official Discord community](https://caffeinemc.net/discord) for all of our projects. By joining, you can:\n- Get installation help and technical support with all of our mods\n- Be notified of the latest developments as they happen\n- Get involved and collaborate with the rest of our team\n- ... and just hang out with the rest of our community.\n\n---\n\n### Building from sources\n\nSupport is not provided for setting up build environments or compiling the mod. We ask that\nusers who are looking to get their hands dirty with the code have a basic understanding of compiling Java/Gradle\nprojects. The basic overview is provided here for those familiar.\n\n#### Requirements\n\n- JDK 8 or newer\n  - You will need JDK 8 in order to build Phosphor, which can be installed through a supported package manager such as\n    [Chocolatey](https://chocolatey.org/) on Windows or [SDKMAN!](https://sdkman.io/) on other platforms. If you'd prefer to\n    not use a package manager, you can always grab the installers or packages directly from [Adoptium](https://adoptium.net/).\n- Gradle 6.7 or newer (optional)\n  - The [Gradle wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html#sec:using_wrapper) is provided in\n    this repository can be used instead of installing a suitable version of Gradle yourself. However, if you are building\n    many projects, you may prefer to install it yourself through a suitable package manager as to save disk space and to\n    avoid many different Gradle daemons sitting around in memory.\n\n#### Building with Gradle\n\nPhosphor uses a typical Gradle project structure and can be built by simply running the default `build` task. After Gradle\nfinishes building the project, you can find the build artifacts (typical mod binaries, and their sources) in\n`build/libs`.\n\n**Tip:** If this is a one-off build, and you would prefer the Gradle daemon does not stick around in memory afterwards,\ntry adding the [`--no-daemon` flag](https://docs.gradle.org/current/userguide/gradle_daemon.html#sec:disabling_the_daemon)\nto ensure that the daemon is torn down after the build is complete. However, subsequent builds of the project will\n[start more slowly](https://docs.gradle.org/current/userguide/gradle_daemon.html#sec:why_the_daemon) if the Gradle\ndaemon is not available to be re-used.\n\n\nBuild artifacts ending in `dev` are outputs containing the sources and compiled classes\nbefore they are remapped into stable intermediary names. If you are working in a developer environment and would\nlike to add the mod to your game, you should prefer to use the `modRuntime` or `modImplementation` configurations provided by\nLoom instead of these outputs.\n\n---\n\n### License\n\nPhosphor is licensed under GNU LGPLv3, a free and open-source license. For more information, please see the [license file](LICENSE.txt).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaffeinemc%2Fphosphor-fabric","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaffeinemc%2Fphosphor-fabric","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaffeinemc%2Fphosphor-fabric/lists"}