Project

encrust

0.0
No commit activity in last 3 years
No release in over 3 years
Converts iTerm2 color schemes to Dwarf Fortress color files.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 2.0
~> 10.0
~> 3.0

Runtime

~> 3.5
 Project Readme

«encrust»

encrust is a command line tool that converts iTerm2 color files (*.itermcolors) to color files usable by Dwarf Fortress.

Installation

encrust requires Ruby. If you have a current version of Ruby installed, it's as simple as:

$ gem install encrust

Otherwise, head on over to Ruby's website and find a version that works for your machine.

Usage

Security considerations

encrust uses the plist gem. Please only feed it files you trust, and check out plist's security considerations section for more information.

encrusting with gems

Just point encrust at the files you'd like converted:

$ encrust gruvbox-dark-soft.itermcolors

It handles multiple files just fine:

$ encrust elflord.itermcolors Earthsong.itermcolors

Your Dwarf Fortress color files will be generated in the directory where you ran the command, and encrust will tell you where Dwarf Fortress expects its active color file to be.

If you want to try out your new color schemes without having to wait for your fortresses to open and close, try uploading the generated files to the Dwarf Fortress Color Generator. DFColorGen also works great for small adjustments to your color schemes.

Why iTerm?

I chose itermcolors as my input format primarily because it supports 24-bit color and is easy to read.

iTerm2 is also pretty popular, and dozens if not hundreds of color schemes for it can be easily found online.

Support Bay 12 Games!

If you like Dwarf Fortress, consider supporting Bay 12 Games either through their patreon or directly through their website.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/molly-cactus/encrust. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Code of Conduct

Everyone interacting in the Encrust project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.