README.md

ClickCrystals Utils

Useful terminal commands for ClickCrystals development.

Commands

There will be more added in the future.

Name: module-table
Usage: module-table
Description: Generates and copies to your clipboard a markdown table of modules and their 
  descriptions by reading your local file system for 
  ClickCrystals module .java files.

Name: version-mappings
Usage: version-mappings
Description: Generates and copies to your clipboard a markdown table of Minecraft versions and their provided 
  ClickCrystals versions, linked to their releases tab

Name: entity-textures
Usage: entity-textures -minecraftVersion
Description: Generates and copies to your clipboard a markdown table of Minecraft entities and their 8x8 head textures!
  These textures are saved as .png files in your 'src/main/resources/assets/clickcrystals/textures/display/icons/entities'
  folder. The last '-raw' argument is optional. Raw will let you view all available Base64 textures, while 
  executing this command without raw will give you are shorter concise list with no texture variants (only one texture per entity).

Name: scripting
Usage: scripting -regex
Description: Generates and copies to your clipboard a long regex capable of selecting any ClickCrystals script command.

Name: scripting
Usage: scripting -json
Description: Generates and copies to your clipboard a Json Object representing the Format class for your script regex parser.

Name: scripting
Usage: scripting -files
Description: Generates an entire file tree consisting of all necessary documentation files for CCS scripting.

How to Use?

(Optional, but it's recommended to create a batch file for this)

In the .bat file:

"%JAVA_HOME%\bin\java" -jar downloadedReleaseFilePath.jar %*

Then in terminal:

./yourBatchFileName modules
./yourBatchFileName packets -1.21

Happy ClickCrystals coding!