ToxicMushroom/Penumbra
1
0
Fork 0
mirror of https://github.com/xivdev/Penumbra.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
FINAL FANTASY XIV modding, but actually good this time
1491 commits 12 branches 411 tags 14 MiB
Find a file
Exter-N 686c53d919 Material editor: Customizable highlight color
2023-09-01 18:46:31 +02:00
.github/workflows make testing tags testing_ instead of t. 2023-06-12 15:30:11 +02:00
.idea/.idea.Penumbra/.idea Create enable/disable functions and clean up PR. 2021-10-19 11:30:08 +02:00
images New icon, newlines in repo.json 2021-10-08 18:56:56 +02:00
OtterGui@728dd8c33f Some formatting in Materials.Shpk. 2023-08-31 01:01:10 +02:00
Penumbra Material editor: Customizable highlight color 2023-09-01 18:46:31 +02:00
Penumbra.Api@97610e1c9d Increment API 2023-08-10 17:01:55 +02:00
Penumbra.GameData@1c68fd5efb Update GameData 2023-08-25 17:46:53 +02:00
Penumbra.String@5d9f36c5b5 Only Trim End on RelPath. 2023-04-29 19:18:11 +02:00
.editorconfig tmp 2023-03-13 10:04:48 +01:00
.gitignore Upgrade to SDK-style .csproj file 2020-09-15 18:32:06 +02:00
.gitmodules Add GameData as submodule. 2023-07-25 15:56:38 +02:00
Penumbra.sln Remove outdated file. 2023-07-13 00:45:01 +02:00
README.md Update README.md 2022-07-17 12:49:52 +02:00
repo.json [CI] Updating repo.json for testing_0.7.3.3 2023-08-31 16:36:03 +00:00

README.md

Penumbra

Penumbra is a runtime mod loader for FINAL FANTASY XIV, with a bunch of other useful features baked in:

  • No need to back up your install - mods don't touch game files
  • Disable and enable mods without restarting the game
  • Resolve conflicts between mods by changing mod order
  • Files can be edited and are often replicated in-game after a map change or closing and reopening a window

Support

Either open an issue here or join us in Discord.

Contributing

Contributions are welcome, but please make an issue first before writing any code. It's possible what you want to implement is out of scope for this project, or could be reworked so that it would provide greater benefit.

TexTools Mods

Penumbra has support for most TexTools modpacks however this is provided on a best-effort basis and support is not guaranteed. Built in tooling will be added to Penumbra over time to avoid many common TexTools use cases.

Installing

While this project is still a work in progress, you can use it by adding the following URL to the custom plugin repositories list in your Dalamud settings An image-based install (and usage) guide to do this is provided by unaffiliated user Serenity: https://reniguide.info/

  1. /xlsettings -> Experimental tab
  2. Copy and paste the repo.json link below
  3. Click on the + button
  4. Click on the "Save and Close" button
  5. You will now see Penumbra listed in the Available Plugins tab in the Dalamud Plugin Installer
  6. Do not forget to actually install Penumbra from this tab.

Please do not install Penumbra manually by downloading a release zip and unpacking it into your devPlugins folder. That will require manually updating Penumbra and you will miss out on features and bug fixes as you won't get update notifications automatically. Any manually installed copies of Penumbra should be removed before switching to the custom plugin respository method, as they will conflict.