Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/despical/fileitems
File Items is a very lightweight library that helps loading items with customizable features from a YAML file.
https://github.com/despical/fileitems
library minecraft
Last synced: about 1 month ago
JSON representation
File Items is a very lightweight library that helps loading items with customizable features from a YAML file.
- Host: GitHub
- URL: https://github.com/despical/fileitems
- Owner: Despical
- License: gpl-3.0
- Created: 2024-09-18T17:49:29.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-28T18:14:32.000Z (about 2 months ago)
- Last Synced: 2024-10-28T19:28:50.609Z (about 2 months ago)
- Topics: library, minecraft
- Language: Java
- Homepage:
- Size: 3.09 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
File Items
[](https://github.com/Despical/FileItems/actions/workflows/build.yml)
[](https://github.com/Despical/FileItems/releases/latest)
[](https://jitpack.io/#Despical/FileItems)
[](../LICENSE)
[](https://javadoc.jitpack.io/com/github/Despical/FileItems/latest/javadoc/index.html)
File Items is a very lightweight library that helps loading items with customizable features, such as display names, glowing effects,
hidden tooltips, amounts, lore, data, durability, unbreakable item flags, and custom keys from a YAML file.
## Documentation
- [Wiki](https://github.com/Despical/FileItems/wiki)
- [JavaDocs](https://javadoc.jitpack.io/com/github/Despical/FileItems/latest/javadoc/index.html)
## Donations
- [Patreon](https://www.patreon.com/despical)
- [Buy Me A Coffee](https://www.buymeacoffee.com/despical)
## Using File Items
The project isn't in the Central Repository yet, so specifying a repository is needed.
To add this project as a dependency to your project, add the following to your pom.xml:
### Maven dependency
```xml
jitpack.io
https://jitpack.io
```
```xml
com.github.Despical
FileItems
1.0.6
```
### Gradle dependency
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
```
```groovy
dependencies {
implementation 'com.github.Despical:FileItems:1.0.6'
}
```
## Example usage
```java
import org.bukkit.plugin.java.JavaPlugin;
/**
* @author Despical
*
* Created at 19.09.2024
*/
public class ExamplePlugin extends JavaPlugin {
@Override
public void onEnable() {
// Create the file if not exist.
ItemManager itemManager = new ItemManager(this);
itemManager.addCustomKey("slot");
itemManager.registerItems("items", "game-items");
SpecialItem item = itemManager.getItem("leave-item");
int slot = item.getCustomKey("slot");
getServer().getOnlinePlayers().forEach(player -> player.getInventory().setItem(slot, item.getItemStack()));
}
}
```
```yaml
game-items:
leave-item:
name: "&c&lReturn to Lobby &7(Right Click)"
material: RED_BED
slot: 8
lore:
- "&7Right-click to leave to the lobby!"
```
## License
This code is under [GPL-3.0 License](http://www.gnu.org/licenses/gpl-3.0.html)
See the [LICENSE](https://github.com/Despical/FileItems/blob/main/LICENSE) file for required notices and attributions.
## Contributing
I accept Pull Requests via GitHub. There are some guidelines which will make applying PRs easier for me:
+ Ensure you didn't use spaces! Please use tabs for indentation.
+ Respect the code style.
+ Do not increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
You can learn more about contributing via GitHub in [contribution guidelines](../CONTRIBUTING.md).
## Building from source
To build this project from source code, run the following from Git Bash:
```
git clone https://www.github.com/Despical/FileItems && cd FileItems
mvn clean package
```
> [!IMPORTANT]
> **[Maven](https://maven.apache.org/)** must be installed to build this project.