Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Hacktoberfest] Wiki/Documentation #191

Open
tr7zw opened this issue Oct 3, 2022 · 2 comments
Open

[Hacktoberfest] Wiki/Documentation #191

tr7zw opened this issue Oct 3, 2022 · 2 comments
Labels
hacktoberfest Issues fitting for hacktoberfest help wanted

Comments

@tr7zw
Copy link
Owner

tr7zw commented Oct 3, 2022

Hey there.
Sadly the wiki(as the intended primary documentation of code examples/how-to-s) has been quite unmaintained for a long time. Some examples are only available on the horrible SpigotMC's page sourcecode, the Spigot forums, or Discord.
Therefore, I set up the wiki's source to be auto-deployed from the master branch of this repository(https://github.com/tr7zw/Item-NBT-API/tree/master/wiki). From now on, code examples, pitfalls, guides, and documentation can be supplied to the wiki with a normal pull request.
For Hacktoberfest, feel free to create a piece of example code, clean up the wording, or update the documentation of the wiki. Then provide it as a valid pull request for Hacktoberfest.

Some examples that need updated code examples/guides:

  • Creating player heads with textures in 1.8-1.19
  • Keeping custom data from an item -> placed BlockEntity -> back to item
  • Adding custom logic to items(on right-click/drop/pickup/other events)
  • Adding custom data to 1.8-1.13 mobs via some item slot
  • Adding custom data to 1.14+ Entities and BlockEntities
  • Copy over data from one item to another
  • Keeping track of custom Entities without causing lag
  • Keeping track of custom player properties without causing lag
  • Storing an inventory in an item/non inventory block entity
  • Shading on Gradle
  • Links to the places where the API can be downloaded(Modrinth/Bukkit)
  • Better link to the Javadoc(https://tr7zw.github.io/Item-NBT-API/v2-api/ https://tr7zw.github.io/Item-NBT-API/v2-plugin/)
  • Documentation of plugins/servers? using the NBTAPI(instead of SpigotMCs description)
@tr7zw tr7zw added help wanted hacktoberfest Issues fitting for hacktoberfest labels Oct 3, 2022
@c99SRS
Copy link

c99SRS commented Oct 6, 2022

HI @tr7zw can you assign this one to me please?

@tr7zw
Copy link
Owner Author

tr7zw commented Oct 6, 2022

HI @tr7zw can you assign this one to me please?

The issue is open in general since I don't expect anyone to do ALL of that. For Hacktoberfest afaik only the PRs are important(tagged correctly).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest Issues fitting for hacktoberfest help wanted
Projects
None yet
Development

No branches or pull requests

2 participants