BackInPack plugin documentation for version 3.0-BETA
This page provides information for broader configuration and serves as a kind of guide to improve the operation of the plugin.
- Updating the plugin
- Placeholders
- Adding your own language files
1. Updating the plugin
While using the plugin, you may see information about the availability of updates from time to time.
![[IMG]](/proxy/image?url=https%3A%2F%2Fcdn.discordapp.com%2Fattachments%2F1009784232601718825%2F1152644828522352730%2FBackInPackUpdate.png)
In such a situation, you should pay attention to the identifier of the new and old version.
![[IMG]](/proxy/image?url=https%3A%2F%2Fcdn.discordapp.com%2Fattachments%2F1009784232601718825%2F1152644792426168372%2FVersionExplain.png)
MAIN - The main version of the plugin. It is changed when a significant number of new functions are added to the plugin or functions that significantly change the operation of the plugin and its purpose.
FUNCTION - Update in the form of adding a new function/package, fixing a large number of bugs or other visible changes.
CORRECTION / BUG FIX - An update that fixes minor bugs without changing any data or options in the files.
After downloading the updated version of the plugin, it is not always
enough to just replace the file with the
.jar extension.
When updating the plugin, you should now pay attention to the numbers that have changed. If these are numbers in the
MAIN or
FUNCTION position, then it is
REQUIRED to recreate the plugin files. This can be done by deleting existing ones such as
config.yml,
language files and other configuration files.
IMPORTANT! Always read the list of changes that have been made before updating. There you will find information regarding required file updates.
2. Placeholders
There are two types of placeholders available in the plugin:
PLAYER and
CONFIG.
These two types mainly differ in that player placeholders refer to a specific player and can only be used in certain cases, while config placeholders can be used in all messages sent by the plugin and in other plugins (provided that the plugin supports placeholders) .
Each placeholder begins and ends with
% and contains the first word
backinpack.
%backinpack_placeholder%
Some placeholders refer to the same value but can be written in different ways.
Player placeholders:
Config placeholders:
The config placeholder names are created based on the variable names in the
config.yml file.
3. Adding your own language files
You can add your own language file to the plugin which will contain your own messages.
You can do this in 2 ways: edit an existing file or create a new one.
Start here if you are creating a new file
1. Duplicate an existing file e.g.
en.yml
2. Change the file name to whatever you want (I recommend adding the language code here)
Start here if you are editing an existing file
3. Edit the messages that are inside the file
4. Save your changes
5. Open the
config.yml file and change the
language option to the name of your file (do not add the .yml file extension)
en.yml => en
6. Save the file
config.yml
7. Restart the server
You should now be able to see your edited file in your messages.
AT THE END
More points in the documentation will be added gradually as updates or topics are raised by plugin users.