Giter Club home page Giter Club logo

enchantmentdetails's Introduction

EnchantmentDetails

A small datapack that adds descriptions to enchantment books

This datapack will have nearly no effect on performance - There is no code that runs every tick.

Preview image

Compatibility

Use this table to check if your minecraft version will be compatible with the datapack. These are only officially tested versions, but all after 1.17 should be compatible
Date format is mm/dd/yyyy
Note that this datapack will never be ported to pre 1.17

MC Version Datapack Version Date
1.17.* 1.2.0 05/02/2022
1.18.* 1.2.0 05/01/2022
1.19.* 1.3.0 08/17/2022

How to install

This datapack can be installed like any other datapack, there is nothing extra to do before it works.

  1. Download the version you want from here: Latest | All Releases
  2. Press WIN + R and type "%appdata%" (without quotation marks)
  3. In the file explorer window that popped up, navigate to ".minecraft/saves"
  4. Find the world you wish to add the datapack to
  5. Once in the world folder, navigate to the "datapacks" folder and drop the datapack file you downloaded earlier into that folder
  6. Start your minecraft world, or if it's already open do "/reload"

Modifications

If you wish to modify this datapack, feel free to use the python scripts found inside of the scripts/ directory. They are used to generate all the files for advancements, functions and item_modifiers.

Theses scripts require the pandas library to read the spreadsheet file.

pip install pandas

The enchantment names (as given in Minecraft's code), the descriptions and what items the enchants apply to can be edited in the spreadsheet "Enchantment Details.xlsx".

enchantmentdetails's People

Contributors

supercam19 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

enchantmentdetails's Issues

New banner image and pack.png

Right now, the banner image for the datapack is low effort and unapealing. The datapack also lacks a pack.png, which is less of an issue since it is rarely seen, but it would make a nice addition to make the datapack feel more complete.

  • Create new banner image
  • Create pack.png

Book detection in chests

This seems to be the next logical step in improving this datapack, adding the ability to detect and update the descriptions of enchanted books inside of chests. Since only in very rare scenarios will an enchanted book end up in a player placed chest without going through a players inventory, it might be best to try to make this process only happen upon the generation of a naturally spawning chest. If I am correct (which I probably am not) enchanted books will only naturally spawn in chest blocks, and in no other storage block, which means I shouldn't have to add detection to barrels, for example.

Version 1.2.0 checklist

A checklist of small additions, changes and fixes that I will be completing for the 1.2.0 update.

Additions

  • Console logging for python scripts, such as when there's an error or to indicate that the files were successfully generated

Changes

  • Change several enchantment descriptions to better represent what the enchantment does
  • Add a generate_pack.py script that generates all files for the datapack at once.
  • Empty output folder when running one of the generator scripts, so you don't have .mcfunction and .json files in the same folder at once
  • Add json formatting (indentations and newlines) to the generated advancement files
  • README.md updates:
    • Add install instructions
    • Test compatible minecraft versions, and create list

Fixes

  • Fix several enchantment descriptions with spelling mistakes
  • Fix sweeping edge not getting a description

More may be added before the 1.2.0 update is released.

Spreadsheet with enchantment descriptions

I think it would be convenient for people who want to change something in the datapack to have a spreadsheet which the python scripts will read from to generate description files. This way the spreadsheet (and thus the descriptions) can be modified very easily, and by running a python script generate the files for the enchantment descriptions.

This would also make translation very easy to make.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.