Print

Please login or register.
1 Hour 1 Day 1 Week 1 Month Forever
Login with username, password and session length

[Button]

BAMM!
Button's Automated Mod Merger
v0.1: The Graphicsenating

BAMM! v0.1 is a utility for applying tilesets to DF raws. It will work with (almost?) any mod. It will work with (almost*) any graphics/tileset. It is currently in pre-release alpha, and only available as Python 3 source code. I will provide an executable once I've gotten rid of those "almost"s.

* Overrides, non-text files and graphics_*.txt files not yet supported. These are easy to do manually - I've only neglected them because I don't need them personally, and will get around to them. Graphics applied as part of creature variations are also not yet supported. This is harder, but very unusual.

Get it here.

Spoiler: Testimonials (click to show/hide)

I can't thank you enough for releasing this wonderful program. There's no way I could have manually gone through all of those gem raws without loosing my mind. 8I

I took a look at BAMM once I got home, and discovered it is much more advanced than what I was using for Rubble. Of course I proceeded to rewrite Rubble's system so it does what BAMM does (more-or-less)

Spoiler: Usage Instructions (click to show/hide)

0. If you don't already have it installed, follow the instructions at the Python for Beginners Download Page to install Python 3.

1. Download the DF-BAMM code from github as a zip file.



2. Extract the zip to where-ever you like.

3. Open resources/run.config with a text editor.



4. Edit 'source' to point to the directory holding the graphics you want to use. Edit 'target' to point to the directory holding the raws you want the graphics applied to. Edit 'output' to point to the directory you want your new, modified raws written to. This directory must not be the same as the target directory. The program doesn't check, so if you do it, it's going to turn your target raws into a hot mess. Files in the output directory will be overwritten.

For this example, I'm going to apply the Obsidian tileset to the new mini-release of the Modest Mod.



Relative paths are fine too.

5. Save run.config and go back to the DF-BAMM-master directory.

6. Queue up some music and get ready to run run_default.py .



3, 2, 1 let's bamm



7. When it's done the console will automatically exit, and your raw files will be waiting for you in the output directory .

You'll also see two new files in the BAMM directory.



bamm.log is a general log. It's what you saw on the console, and it's pretty much just for curiosity and/or debugging.

missing.log tells you what objects in the target raws weren't found in the graphics raws. BAMM doesn't know what to do if it finds graphics information in your target raws that doesn't have an equivalent in your graphics raws, so it copies the target raws over, logs the discrepancy in missing.log, and writes a comment at the point of failure in the output raws. You can find the exact problem points by searching for the string 'BAMM' in your raw files.

[Max™]

Sadly I know little about python yet but I love the name!

[Meph]

If that works on Masterwork, I'll hug you to death. This is meant as a compliment, not a threat.

[DragonDePlatino]

I see what you did there.

Does this override things in the raws like [PICKED_TILE] or [GROWTH_PRINT]? Was it our earlier little discussion that spawned this beautiful script? Does this mean I have to stop being lazy and create unique tiles for all of the plant growths?

If so:

Spoiler (click to show/hide)

[Button]

If that works on Masterwork, I'll hug you to death. This is meant as a compliment, not a threat.

It should, with a little work. It scans the target directory and the graphics directory for objects, matches up shared objects, and then applies the graphics. So new or relocated target objects will require corresponding new or relocated graphics objects.

However since it will pull the graphics from any set of raws, you only need to manually assign them to new or relocated objects once. Then you use that place as your new graphics source directory.

Also, at the moment it's just doing the text part. I'm going to add copying over all the image files etc. this weekend. Should be easy, just a regex.

I see what you did there.

Does this override things in the raws like [PICKED_TILE] or [GROWTH_PRINT]? Was it our earlier little discussion that spawned this beautiful script? Does this mean I have to stop being lazy and create unique tiles for all of the plant growths?

You flatter me. I couldn't possibly have made this in the time since that post - I've been working on it for more than a month, off and on. Though I confess, you did influence the timing for the upload.

Sadly I know little about python yet but I love the name!

I know, right? Since this doesn't do mod merging yet, only graphics application, I was thinking of giving it a more descriptive name, but BAMM!

[Button]

Update: Found a bug for GROWTH_PRINT tags with no priority token. Fixing it raised another problem, which I'm working on now. Once it's fully fixed I'll check it in again.

[Button]

I believe the previous has now been fixed.

[milo christiansen]

This sounds a lot like the Rubble tileset applier, but implemented a bit differently.

Is this just for raws, or does it handle TWBT overrides as well? Because if it's just for raws you may want to take a look at how Ruble does it, source code (for the tileset applier) is in "other/src/rubble/rblutil/tset" in the main Rubble download. Rubble uses minimal objects to patch existing raws with new tile information, and it has the ability to auto generate tileset files from existing raws (so if your format is close to what I use then we can share tilesets).

[Button]

At the moment it's raws only, but TWBT overrides is high on my list and I know how I intend to do it.

I will take another look at Rubble. My goal with this, though, is to have a util that can be run by the most tech- and modding-shy of users, and Rubble is not exactly plug-and-play.

[milo christiansen]

Rubble is intended to be a giant all-in-one tool/installer/etc/etc, so not plug and play, at least not for modders But really you can't call a python script plug and play either, not for Windows users.

I was more thinking that if we use a unified tileset format it would be possible to make tileset packages that work with both tools. Ideally it may be possible to make a standard tileset format that can be used by a spectrum of tools, hopefully fixing all tileset install problems for all time Rubble's format is simple, but it needs some good TWBT support and maybe a few other tweaks.

Rubble has some nice, simple (non-regular expression) raw parsing and tileset patching code that may be helpful, even if it is in Go and not python you can still steal (er, use) the basic logic if you want.

I am open to changing Rubble to match another tool's format, but only if functionality is enhanced.

[Button]

Rubble is intended to be a giant all-in-one tool/installer/etc/etc, so not plug and play, at least not for modders But really you can't call a python script plug and play either, not for Windows users.

Well obviously I intend to package it as an executable once it's out of alpha .

I was more thinking that if we use a unified tileset format it would be possible to make tileset packages that work with both tools. Ideally it may be possible to make a standard tileset format that can be used by a spectrum of tools, hopefully fixing all tileset install problems for all time Rubble's format is simple, but it needs some good TWBT support and maybe a few other tweaks.

Well, my tileset format is flexible. It's built to pull the tileset from any raws which have the tileset installed. I'll take a look at yours this weekend.

[DragonDePlatino]

If I could give my two cents, I'm all for Button's format. When I started editing my raws for GemSet, I wrote a file like this with the intention of documenting all of my changes.

Spoiler (click to show/hide)

Code: [Select]

[INORGANIC:LOAM]
[TILE:178]

[INORGANIC:LOAMY_SAND]
[TILE:178]

[INORGANIC:PEAT]
[TILE:178]

Button then popped in the topic and said I had hit BAMM!'s format by accident, minus the color codes. It's a really intuitive setup in that respect.

On the other hand, I've been having some issues with overriding my grass graphics. I wrote this set of plant_grasses raws and my output folder ended up exactly like the vanilla raws. Am I doing something wrong?

Spoiler (click to show/hide)

Code: [Select]

[PLANT:MEADOW-GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:HAIR GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:BENTGRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:RYEGRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:FESCUE GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:REEDGRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:KNOTGRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:ZOYSIA]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:DOG'S TOOTH GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:DALLISGRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:CARPETGRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:SATINTAIL]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:GRAMA]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:DROPSEED GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:NEEDLE GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:BABY TOES SUCCULENT]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:2:0:0:6:0:0]

[PLANT:PEBBLE PLANTS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:2:0:0:6:0:0]

[PLANT:BLUE SEDGE]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:FIELD SEDGE]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:PURPLE MOOR GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:VELVET GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:MEADOWSWEET]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:RUSH]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:MARSH THISTLE]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:COMMON REED]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:CATTAIL]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:SAWGRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:COTTONGRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:WHITE MOUNTAIN HEATHER]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:MOUNTAIN AVENS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:CLOUDBERRY]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:10:0:0:2:0:0:14:0:0:6:0:0]

[PLANT:WORMY TENDRILS]
[GRASS_TILES:242:243:169:170]
[GRASS_COLORS:13:0:0:5:0:0:8:0:0:6:0:0]

[PLANT:EYEBALL]
[GRASS_TILES:'O':'o':9:248]
[GRASS_COLORS:15:0:0:7:0:0:8:0:0:6:0:0]

[PLANT:BUBBLE BULBS]
[GRASS_TILES:'O':'o':9:248]
[GRASS_COLORS:11:0:0:3:0:0:8:0:0:6:0:0]

[PLANT:DOWNY GRASS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:15:0:0:7:0:0:8:0:0:6:0:0]

[PLANT:CAVE MOSS]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:11:0:0:3:0:0:8:0:0:6:0:0]

[PLANT:FLOOR FUNGI]
[GRASS_TILES:'.':',':'`':''']
[GRASS_COLORS:11:0:0:3:0:0:8:0:0:6:0:0]

[PLANT:BAMBOO, ARROW]
[GRASS_TILES:231:159:231:159]
[GRASS_COLORS:10:0:0:10:0:0:8:0:0:6:0:0]

[PLANT:BAMBOO, GOLDEN]
[GRASS_TILES:231:159:231:159]
[GRASS_COLORS:10:0:0:10:0:0:8:0:0:6:0:0]

[PLANT:BAMBOO, HEDGE]
[GRASS_TILES:231:159:231:159]
[GRASS_COLORS:10:0:0:10:0:0:8:0:0:6:0:0]

[Button]

When you say "overriding," do you mean that you put them into the graphics_overwrite property in the run.config? Because if so, that's the problem - that's still not implemented.

If not, then it should be working fine. I'll poke around with it.

EDIT: Aha! Since it's a plant file, it needs [OBJECT:PLANT] up at the top of the file. Although from a purely raws-structural point of view this is correct, since it's not really relevant to the data it's looking at, I'll check and see if it breaks anything to remove that requirement.

EDIT2: It didn't break anything, so I've pushed it and you don't need [OBJECT:WHATEVER] up at the top of their respective short-form graphics files anymore.

[DragonDePlatino]

Nice! I've been able to get lots of stuff to work other than plants, and it's a relief one of the most complicated things should be working now. I'll go ahead and download it and give it a shot.

Speaking of which...I think I've changed my mind about getting an executable. I'm already able to do everything I want with the current version (i.e. override soil, layer, mineral and gem raws) so I'll be interested in getting an executable for the next version of GemSet.

[Button]

Added proper logging. There's the generic logging, but then there's also a log specifically for modders - missing.log , which catalogs which objects were found in the target source but not in the graphics source. So that you know where to look for touchups.

Speaking of which...I think I've changed my mind about getting an executable. I'm already able to do everything I want with the current version (i.e. override soil, layer, mineral and gem raws) so I'll be interested in getting an executable for the next version of GemSet.

Do you have a target date for that?