Skip to content

Commit 44959a2

Browse files
fancyholograms v3: Update CHANGELOG
1 parent 8c98524 commit 44959a2

1 file changed

Lines changed: 22 additions & 3 deletions

File tree

plugins/fancyholograms/CHANGELOG.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,16 @@ Things that will **not** be migrated automatically:
1414
The API has changed significantly, so you will have to update your code accordingly.
1515
Read more about the new API [here](#new-api).
1616

17-
## New Commands
17+
## New Commands & Translations
18+
19+
In v3, all commands have been rewritten and simplified.
20+
If you're using FancyNpcs, you will notice that the commands are now more consistent with the FancyNpcs commands.
21+
It's now using the [Lamp command framework](https://github.com/Revxrsal/Lamp), which allows for better command handling and easier command creation.
22+
23+
Not only the command structure has changed, but also the responses.
24+
All responses are now configurable. You can find the default responses in the `plugins/FancyHolograms/languages/default.yml` file.
25+
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.).
26+
Remember to set the `language` option in the `config.yml` file to your language code.
1827

1928
## New Storage System
2029

@@ -83,11 +92,17 @@ The `text_data` component contains the text settings for the hologram, such as t
8392

8493
**Disclaimer:** all configuration options do not migrate automatically. You will have to update your configuration files manually.
8594

95+
The feature flags are now stored in the `config.yml` too. You can find them under the `experimental_features` section.
96+
8697
## New API
8798

99+
TODO
100+
88101
## Traits
89102

90-
Traits are a new feature in v3 that allow you to extend the functionality of holograms.
103+
**Disclaimer:** the trait system is still in beta and may change in the future.
104+
105+
Traits are a new feature in v3 that allows you to extend the functionality of holograms.
91106
A trait is basically a plugin that can be added to a hologram to add new features or functionality.
92107
Traits have access to the hologram's data and lifecycle, allowing them to modify the hologram's behavior or appearance.
93108
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:
99114
- `file_content_trait`: Allows you to display the content of a file in a hologram
100115

101116
You can also create your own traits by extending the `HologramTrait` class.
102-
View the Javadocs for more information about how the `HologramTrait` class is structured.
117+
View the [Javadocs]() for more information about how the `HologramTrait` class is structured.
103118
You can override all the `on` methods, as well as the `load` and `save` methods.
119+
120+
Every trait has a `storage` JDB (JSON Database) object that can be used to store data related to the trait.
121+
The JDB will save the data to the `plugins/FancyHolograms/data/traits/<trait name>/` folder, all paths are relative to this folder.
122+
You can read more about the JDB [here]().

0 commit comments

Comments
 (0)