Print

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

[Frizzil]

Hello one and all,

I just created a very simple package for Sublime Text that syntax highlights the DF raws.  If you don't already have an IDE (ie, a text editor for programmers), I strongly recommend downloading Sublime, as it'll make those raws a thousand times easier to look at

Should I mention that this IDE is both fantastic, fully-featured, and free?  Hehe.

Images:

Spoiler (click to show/hide)

Download and Instructions:

Spoiler (click to show/hide)

First, install Sublime Text if you don't already have it.  Then, install the DFML (Dwarf Fortress Markup Language) package by one of the following three methods:

With Package Control (Temporarily Unavailable):

• Install Package Control for Sublime if you don't already have it.
• Open Sublime.
• Open the Command Palette (ctrl+shift+p by default) and select "Package Control: Install Package", then search for "DFML"
• Mash enter, and it'll be installed almost instantly!

Manually:

• Navigate to the Packages directory.  On Windows, it's located under "<user>\AppData\Roaming\Sublime Text 2\", whereas on Mac, it's probably somewhere under "<user>/Library/Application Support/".  Both "<user>/AppData" on Windows and "<user>/Library" on Mac are hidden by default.
• Download the zipped package.
• Extract the innermost contents of the zip file into a new folder named "DFML" under "Packages".  That is, extract the insides of the zip such that "DFML" contains zero folders, only a few files.
• You're done!

With Git (for Developers):
If you want to contribute as a developer, you can make a clone of the repository into your Packages directory by way of either github or git from the terminal:

Code: [Select]

git clone git://github.com/philipguin/dfml-sublime-package.git 'DFML'Let me know if you want to be a dev and I'll help you get set up

Once installed, you can select DFML in Sublime by clicking the bottom-right of the window where the current syntax is displayed.

Happy modding!

[Putnam]

Ah, nice. I expanded an old one from 40d for Notepad++ a little while back, but it only has creature raws for now, so I'm probably not releasing it. Also, it also has this annoying thing with apostrophes, which is why you'll see stray apostrophes in my code .'

[Frizzil]

Ah, nice. I expanded an old one from 40d for Notepad++ a little while back, but it only has creature raws for now, so I'm probably not releasing it. Also, it also has this annoying thing with apostrophes, which is why you'll see stray apostrophes in my code .'

Thanks, it's fairly simple, really

Only creature raws?  Oh dear, you didn't hard-code in every token did you???  That sounds like a nightmare XD  I basically just treat the first component of a token as the "type", then further components as parameters.  Anything not in between brackets is considered a comment.  It's all Regex magic in Sublime, no validation of token types or anything.

Though that does give me an idea... just make a web scraper for the token lists on the wiki, build a table, then you have validation   I don't think you'd be able to reference your own created types, however.

[Putnam]

Nope, hehe. This should work much better for me. Besides, Notepad++ was getting annoying with needing admin permission to run.

[Frizzil]

Nope, hehe. This should work much better for me. Besides, Notepad++ was getting annoying with needing admin permission to run.

*whew* You had me going there, heh.

I don't think Sublime requires admin, but there's a good chance manual installation of the package does, since you'd be fiddling inside the AppData which is hidden by default.  Package Control would probably work, but it's still getting set up by the devs on their end   Should be up tomorrow or the day after, hopefully.

[CLA]

Notepad++ needing admin permission to run.

Huh? What system do you run that on? I never had that problem. I have a portable install on win7, somewhere outside of program files.

[Vherid]

Damn this is a sexy program.

[Putnam]

Notepad++ needing admin permission to run.

Huh? What system do you run that on? I never had that problem. I have a portable install on win7, somewhere outside of program files.

it doesn't need it to run, I just have it set up to require admin permission to start for easier cfg editing and such in steam, which is in the program files folder.

[Dragoon209]

I've started using this, and found it very handy!  I wasn't aware that something like Sublime Text existed!  I was using notepad++, but this seems to have taken over for now.  I like that its multiplatform, and the default theme is really nice and readable.

Do you have any plans on expanding on this?  For instance, different colors for different tag types? (Tools, Items, Reactions, etc.)

[Itnetlolor]

Although not intended for this use, I always considered the Smalltalk syntax highlight language in Notepad++ to work well for DF raws in most cases. Then again, I'm also looking at 40d raws with it.

It actually has a decent highlighting scheme to it.

For example it displays something like this (mind my labeling):
[RAW:#Value:#Value]
[RAW:STRING_VALUE/FLAG]
[PREFSTRING:string value/flag]
[BENIGN]

It does a pretty good job on it's own.

[zwei]

Thank you for this tool! I was about to make my own highlighter for Sublime Text 3 - and your works perfectly.

[jaked122]

Only creature raws?  Oh dear, you didn't hard-code in every token did you???  That sounds like a nightmare XD  I basically just treat the first component of a token as the "type", then further components as parameters.  Anything not in between brackets is considered a comment.  It's all Regex magic in Sublime, no validation of token types or anything.

That's the wimpy approach.

We don't have optimizing regex engines these days for naught. Go out and send a python script rummaging through all your raws and take all the tags, put them into the sublime syntax, and watch in amazement as it performs reasonably well, against all odds and hopes.