fancyholograms v3: Update CHANGELOG

This commit is contained in:
Oliver
2025-07-19 20:52:18 +02:00
parent 8c98524d37
commit 44959a2fbb

View File

@@ -14,7 +14,16 @@ Things that will **not** be migrated automatically:
The API has changed significantly, so you will have to update your code accordingly. The API has changed significantly, so you will have to update your code accordingly.
Read more about the new API [here](#new-api). Read more about the new API [here](#new-api).
## New Commands ## New Commands & Translations
In v3, all commands have been rewritten and simplified.
If you're using FancyNpcs, you will notice that the commands are now more consistent with the FancyNpcs commands.
It's now using the [Lamp command framework](https://github.com/Revxrsal/Lamp), which allows for better command handling and easier command creation.
Not only the command structure has changed, but also the responses.
All responses are now configurable. You can find the default responses in the `plugins/FancyHolograms/languages/default.yml` file.
You can create your own language files in the `plugins/FancyHolograms/languages/` folder, by copying the `default.yml` file and renaming it to your desired language code (e.g. `nl.yml`, `pl.yml`, etc.).
Remember to set the `language` option in the `config.yml` file to your language code.
## New Storage System ## New Storage System
@@ -83,11 +92,17 @@ The `text_data` component contains the text settings for the hologram, such as t
**Disclaimer:** all configuration options do not migrate automatically. You will have to update your configuration files manually. **Disclaimer:** all configuration options do not migrate automatically. You will have to update your configuration files manually.
The feature flags are now stored in the `config.yml` too. You can find them under the `experimental_features` section.
## New API ## New API
TODO
## Traits ## Traits
Traits are a new feature in v3 that allow you to extend the functionality of holograms. **Disclaimer:** the trait system is still in beta and may change in the future.
Traits are a new feature in v3 that allows you to extend the functionality of holograms.
A trait is basically a plugin that can be added to a hologram to add new features or functionality. A trait is basically a plugin that can be added to a hologram to add new features or functionality.
Traits have access to the hologram's data and lifecycle, allowing them to modify the hologram's behavior or appearance. Traits have access to the hologram's data and lifecycle, allowing them to modify the hologram's behavior or appearance.
Each trait can have its own configuration and can be enabled or disabled individually. Each trait can have its own configuration and can be enabled or disabled individually.
@@ -99,5 +114,9 @@ There are several built-in traits that come with FancyHolograms v3:
- `file_content_trait`: Allows you to display the content of a file in a hologram - `file_content_trait`: Allows you to display the content of a file in a hologram
You can also create your own traits by extending the `HologramTrait` class. You can also create your own traits by extending the `HologramTrait` class.
View the Javadocs for more information about how the `HologramTrait` class is structured. View the [Javadocs]() for more information about how the `HologramTrait` class is structured.
You can override all the `on` methods, as well as the `load` and `save` methods. You can override all the `on` methods, as well as the `load` and `save` methods.
Every trait has a `storage` JDB (JSON Database) object that can be used to store data related to the trait.
The JDB will save the data to the `plugins/FancyHolograms/data/traits/<trait name>/` folder, all paths are relative to this folder.
You can read more about the JDB [here]().