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
512 commits 12 branches 411 tags 14 MiB
Find a file
Ottermandias 1ad7787e4c Let the glamour plate actor use the players character collection.
2022-05-31 22:08:35 +02:00
.github/workflows Test: Update build scripts to checkout submodules 2022-04-27 17:42:48 +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@3679cb37d5 Change cache reloading and conflicts to actually keep the effective mod and not force full recalculations on every change. 2022-05-29 19:00:34 +02:00
Penumbra Let the glamour plate actor use the players character collection. 2022-05-31 22:08:35 +02:00
Penumbra.GameData Change cache reloading and conflicts to actually keep the effective mod and not force full recalculations on every change. 2022-05-29 19:00:34 +02:00
Penumbra.PlayerWatch Fix 6.1 offsets. 2022-04-14 16:01:06 +02:00
.editorconfig Applied a slightly expanded .editorconfig to all files, checked the changes and did some simple refactoring-suggestions. 2021-02-16 15:52:57 +01:00
.gitignore Upgrade to SDK-style .csproj file 2020-09-15 18:32:06 +02:00
.gitmodules Add OtterGui reference for shared interface code. 2022-04-15 14:39:23 +02:00
base_repo.json Fix 6.1 offsets. 2022-04-14 16:01:06 +02:00
Penumbra.sln Add OtterGui reference for shared interface code. 2022-04-15 14:39:23 +02:00
README.md Adjust the Installing section of README.md 2022-01-18 08:57:30 -08:00
repo.json [CI] Updating repo.json for refs/tags/0.4.8.1 2022-04-14 14:44:24 +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

Current Status

Penumbra, in its current state, is not intended for widespread use. It is mainly aimed at developers and people who don't need their hands held (for now).

We're working towards a 1.0 release, and you can follow it's progress here.

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 addin the following URL to the custom plugin repositories list in your Dalamud settings

  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 Dalamud Plugin Installer

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.