{"id":15174323,"url":"https://github.com/cozmycdev/pk-guidance","last_synced_at":"2026-02-11T06:34:10.348Z","repository":{"id":249240153,"uuid":"830788298","full_name":"CozmycDev/PK-Guidance","owner":"CozmycDev","description":"A ProjectKorra Spiritual passive ability for illumination","archived":false,"fork":false,"pushed_at":"2024-09-11T06:43:16.000Z","size":35,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-01T11:09:45.964Z","etag":null,"topics":["ability","addon","air","airbending","bending","pk","spigot","spirit","spirits","spiritual"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CozmycDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-07-19T02:16:58.000Z","updated_at":"2024-12-19T19:19:18.000Z","dependencies_parsed_at":"2024-09-23T05:01:27.193Z","dependency_job_id":null,"html_url":"https://github.com/CozmycDev/PK-Guidance","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"a2518355993f67a2af21b09714d68ec0753fbc5b"},"previous_names":["cozmycdev/pk-guidance"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CozmycDev%2FPK-Guidance","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CozmycDev%2FPK-Guidance/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CozmycDev%2FPK-Guidance/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CozmycDev%2FPK-Guidance/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CozmycDev","download_url":"https://codeload.github.com/CozmycDev/PK-Guidance/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232071654,"owners_count":18468551,"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":["ability","addon","air","airbending","bending","pk","spigot","spirit","spirits","spiritual"],"created_at":"2024-09-27T11:43:00.326Z","updated_at":"2026-02-11T06:34:10.318Z","avatar_url":"https://github.com/CozmycDev.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![GitHub Pre-Release](https://img.shields.io/github/release-pre/CozmycDev/PK-Guidance.svg)](https://github.com/CozmycDev/PK-Guidance/releases)\n[![Github All Releases](https://img.shields.io/github/downloads/CozmycDev/PK-Guidance/total.svg)](https://github.com/CozmycDev/PK-Guidance/releases)\n![Size](https://img.shields.io/github/repo-size/CozmycDev/PK-Guidance.svg)\n\n# Guidance Ability for ProjectKorra\n\nThis is an addon ability for the [ProjectKorra](https://projectkorra.com/) plugin for Spigot Minecraft servers. This ability allows players to summon friendly spirits that provide light and assistance. \nThis concept was designed by LuxaelNi.\n\nhttps://github.com/user-attachments/assets/e21559eb-ca2e-48b1-bc52-4e5c203e6b33\n\n## Description\n\n**Guidance** is a Spiritual ability that enables players to summon a 'Spirit Buddy' while in darkness. This friendly spirit follows the player, acting as a moving light source and providing various beneficial effects.\n\n### Features\n\n- **Summon Spirit**: Summon a friendly spirit that follows you around and provides light.\n- **Blindness/Darkness Cure**: Automatically cures blindness and darkness effects from nearby players or through interaction.\n- **Adjustable Follow Distance**: Players can change how far the spirit follows by holding shift and scrolling.\n- **Customizable**: Various settings and defaults can be adjusted, such as particles, light levels, entity types, and names.\n- **Persistent Preferences**: Remembers a player's spirit name and entity type across instances (but not restarts yet).\n\n## Instructions\n\n- **Activation**: When in darkness, friendly spirits will automatically spawn if `DefaultActive` is enabled. With this ability selected, Left Click to toggle the ability on or off. Hold Shift to move the spirit to a specific location.\n- **Adjust Follow Distance**: With this ability selected, hold Shift and scroll to adjust how closely the spirit follows.\n- **Interaction Mechanic**: Players can interact with their spirit by right-clicking, triggering unique effects.\n\n## Installation\n\n1. Download the latest `guidance.jar` file from [releases](https://github.com/CozmycDev/PK-Guidance/releases).\n2. Place the `guidance.jar` file in the `./plugins/ProjectKorra/Abilities` directory.\n3. Restart your server or reload the ProjectKorra plugin with `/b reload` to enable the ability.\n\n## Compatibility\n\n- **Minecraft Version**: Tested and working on MC 1.20.4, 1.21.1 and 1.21.4.\n- **ProjectKorra Version**: Tested and working on PK 1.11.2, 1.11.3, and PK 1.12 BETA 12 and PRE-RELEASE 3.\n\n## Configuration\n\nThe configuration for this ability can be found in the `ProjectKorra` configuration file (`config.yml`). Below are the default settings:\n\n```yaml\nExtraAbilities:\n  Cozmyc:\n    Guidance:\n      DefaultActive: true\n      AlwaysDisplayName: false\n      CureRange: 8\n      Teleport:\n        Sound: true\n        Particles: true\n        Flash: true\n      FollowDistance:\n        AllowChange: true\n        Default: 2\n        Min: 1\n        Max: 10\n      Inspect:\n        Enabled: true\n        Range: 64\n      Boon:\n        Cure:\n          Blindness: false\n          Darkness: false\n        HeartParticles: 5\n      Passive:\n        CureBlindness: true\n        CureDarkness: true\n        ActivationLightLevel: 5\n        EntityLightLevel: 15\n      EntityTypes:\n        Adult:\n          - allay\n          - bat\n          - cat\n          - chicken\n          - frog\n          - ocelot\n          - parrot\n          - rabbit\n          - bee\n          - fox\n          - wolf\n        Baby:\n          - panda\n          - polar_bear\n          - sniffer\n          - goat\n      EntityNames:\n        - '#cab0ffSpirit Buddy'\n        - '#cab0ffFriendly Spirit'\n      Language:\n        Description: Friendly spirits will naturally offer help to proficient airbenders.\n          While in darkness, a 'Spirit Buddy' will spawn, following the player as\n          a moving light source.\n        Instructions: When in darkness, friendly spirits will automatically spawn.\n          With this ability selected, Left Click to toggle the ability on or off.\n          Hold Shift to move the spirit to a specific location or switch item slots\n          to adjust the follow distance.\n        ToggledOn: '\u0026aFriendly spirits are now following you'\n        ToggledOff: '\u0026cFriendly spirits are no longer following you'\n```\n\n## Development\n\n- **Authors**: LuxaelNI, Cozmyc\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcozmycdev%2Fpk-guidance","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcozmycdev%2Fpk-guidance","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcozmycdev%2Fpk-guidance/lists"}