GardenGals-Hatchery icon

Hatchery

Hatchery is a no-code tool for creating your own WebFishing GDWeave mods!

Last updated a month ago
Total downloads 1368
Total rating 9 
Categories Tools Misc
Dependency string GardenGals-Hatchery-1.3.2
Dependants 0 other packages depend on this package

README

Hatchery

Hatchery is a no-code tool for creating your own WebFishing GDWeave mods!
Currently a Python script, this project is in early development and will change forms eventually, likely an executable file made with Godot.
Check out Fishing Expanded, for an example of a project created with Hatchery!

What can Hatchery do?

  • Create functional mod files from a simple spreadsheet, no coding necessary.
  • Create mods from the command line by answering a few questions about your mod (coming soon™️)
  • Generate mod file templates including resources and scripts.
  • Generate asset templates to avoid misnamed assets and godot project corruption.
  • Automatically create metadata for TackleBox, HLS, and Thunderstore.
  • Automatically generate a ReadMe file with info about the content you added to your mod.
  • Automatically zip up your project to be shared as a GitHub release or uploaded to Thunderstore.

New Fish

Thanks to Lure, adding new fish to the game is already pretty simple, with Hatchery you can add the data you want for your fish to a spreadsheet and have as many as you want created all at once!
Note that the example fish.csv already filters out the data you probably don't want to modify, but if you want to make your fish even more exciting, simply add a collumn for the relevant data, Hatchery will handle the rest.
Having trouble balancing your fish? Check out this data sheet for easy reference!

Cosmetic Colors

You can now generate cosmetics via Hatchery!
Cosmetic colors can be generated completely from the colors.csv template with just a name and a Hex Code.

Cosmetic Titles

Cosmetic titles can be generated completely from the titles.csv template with just a name, description, and Title.

Mod files

Hatchery will generate the structure and manifest files for your mod, you just have to answer a few questions, or fill out the example modinfo.json.
Hatchery can generate ReadMe files depicting the content generated in your mod Hatchery can update a Changelog file, and add a logo to your project that will show up in TackleBox or your Thunderstore page Hatchery can automatically generate .zip archives for you to upload to Thunderstore, or to publish as GitHub releases.

Advanced Usage

Technically speaking, as a consequence of how I've designed the script, you can use Hatchery to add any content supported by Lure and inherits item_resource or cosmetic_resource.
If you'd like to use Hatchery for this purpose, simply add any of the data values you'd like to edit as a column in your csv.
This type of use will have easier-to-use options soon, for now, your items will still mostly be processed as if you're trying to create a fish or a cosmetic color.
Note, that colors.csv inputs support two additional entries used by Hatchery, hex and alpha which can be used to make editing the colors of cosmetics easier.
fish.csv inputs support an additional entry, mod_loot_table which can be a single string, or multiple values seperated by a comma (",").

Things to avoid

Empty cells in your .csv files will likely cause the generated files to be invalid.

What can Hatchery not do?

Hatchery can not make your art, or custom scripts for you, that's where you come in!
Hatchery can not export your mod's .pck for you, don't worry, it's pretty easy, check out this quick tutorial!

How do I use Hatchery?

Simply download from the latest Release, get it on Thunderstore, or clone this repository, and run Hatchery.py, your terminal will guide you through the rest.

Links

discord github thunderstore Support us