ShishioValentine / MiqoCrafter

MiqoCrafter is an utility to automatically generate Miqobot gathering/crafting scenarios.
Apache License 2.0
13 stars 3 forks source link

MiqoCrafter - Miqobot automated script generation

Welcome to the MiqoCrafter GitHub!

If you like the software, Become a Patron!

What is MiqoCrafter ?

I just wanted to share with you all a tool I made. It’s call Miqocrafter (You’ll see the reference) and it has one goal : simplify your crafter/gatherer life.

Basically, this is a scenario generator. You just have to search for an item name, and it will generate a complete crafting scenario, including the gathering of needed items.

How does it work ?

Easy !

Open MiqoCrafter, you will see this search window:

Search Window

Simply enter a [partial] item name in the search field at the top, define your search filter by job or item level, and click “Search”.

The list of found item will be displayed on the right.

Search Window

Using the "Search for all kind of items" checkbox, you can also search for other items and create a gather only scenario for example.

Select the item you want to craft in the list, and click “Add to Crafting List”. The crafting list will be filled with the selected item. You can edit the item quantities, and when you're done, click on Craft Items.

Search Window

Another window will pop up. After some time (watch the progress bar on the bottom left), you’ll see all the necessaries ingredients displayed in the list.

Search Window

You can customize the scenario using the options on the left side:

Search Window

Search Window

On the crafting tree on the right, you can modify the number of items, and for crafted items you can set a specific craft macro. The craft macro must be already created in miqobot. See https://miqobot.com/forum/forums/topic/help-crafting/ for more info. Just select one or several items, enter a craft macro name, or edit the quantity and click Apply. The quantity will be adjusted.

Click on “Generate” and bam, you’ll get a complete miqobot-compatible scenario for your item.

See https://miqobot.com/forum/forums/topic/beta-scenario-scripting-engine/ for more info on miqobot scenarios and those options values.

Looks nice ! What’s behind ?

The list of ingredients and crafting steps are found from http://garlandtools.org/. That’s the easy step. Then the hard part is the gatheriing scenario. If you played already with miqobot, you know that a gathering scenario needs a good grid. And this is where I’ll need you.

You need us ?

Yeah ! Basically for each gathered item, Miqocrafter will look in his subfolder CacheGrid if a corresponding grid exists. If not, it will browse miqobot forum to try to get one.(From https://miqobot.com/forum/forums/topic/index-gathering-grids/). Problem is, all of those grid are not “good” grid for Miqocrafter.

Huh ? What’s a “good” grid ?

A good grid will tell Miqocrafter where to teleport, and must also include a path from the teleport location to the gathering nodes. In the description, there should be the zone + aetheryte name specified using the following format : [Zone @Aetheryte Name]

For example : [Yanxia @Namai] [Lower La Noscea @Moraby Drydocks]

From this format, Miqocrafter will know where to teleport.

So I understand that, what can we do ?

Well I’m making the grid myself when I need them, and I’ve only made a few so far. The good news is that pretty much all gathering node level 70+ are usually in the good format (Thanks Timrai) For the others, you may want to manually edit the grid (description and grid paths/beacon/…) so they are in the good format. If you’re kind enough to do so, first you’ll get an automated scenario for yourself, but also please send the grid to me so I can add it to the default software. That way everyone can use them. In the end, that’s what will make this tool really useful.

Any other things we need to know ?

Yeah, you can customize the generated scenario, if you have customized gathering rotation/solver preset. Just add the gathering rotation text file into CacheRotations directory, and solver preset in CacheSolverPresets. You can also customize the gathering presets in CacheGatheringPresets.

What’s next ?

This is a software I intended to make for myself, then realized it could help everyone out. For now I’m planning on adding more customization, as well as testing more scenario when I need them (this daily GC stuff is going to help me out). As a final goal, I’d like the software to generate a full scenario to craft all items. I want those shiny crafting tools ! But if you have other suggestions, tips, rotation proposal, … use this github !

I hope you’ll enjoy this little piece of software, and help me/us out with all those grids 🙂