Print

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

[keda]

Dwarf Script

2010.8.16 Major update: Linux and Windows version 0.13 released.

Minor features:
   - capped views with scrollable output
   - commenting is possible in two variants like in C/C++/Java:
      /* blah */
      // blah
   - stack data is now completely separate from type info, allowing faster execution without passing around type info at all.
   - stack is restored if execution fails (solved a bunch of problems i didn't want to deal with, implementing the above)
   - ascii 0-32 show as "?" inside strings in stack.
   - \123 inside string constants converts to ascii char 123
   - bitwise not
   - the ability to set or unset flags (untested)
   - loop mismatch error is more informative
   - rearranged views
   - used commands are now shown for easy copy/paste until history scrolling works.
   - history scrolling is now also implemented (use up and down keys)
   - added intellisense coloring


Bug fixes:
   - view disruption is fixed through capping and scrollable output
   - fixed disruptions caused by ascii chars 0-31 in strings on the stack
   - $ now displays in execution view
   - code now fetched rather than recompiled at every function call, and various sleeping bugs that this triggered
   - enter no longer executes when there are parse errors
   - fixed a bunch of memory leaks
   - multiline text outputs is now clean
   - functions should now list correctly
   - linux: fixed read4 bug when highest bit set, due to pread having a stupid 2G limit so switched to pread64

Spoiler: update history (click to show/hide)

2010.8.7 Major update: Linux and Windows version 0.12 released.

Addresses/offsets for linux added, except for skills vector

Also fixed:
   using escape characters no longer leave the escape character used
   errors during execution are now no longer overwritten
   linux "reads" reads now full string, not just first character + garbage
   linux "readstl" fixed
   made possible negative numbers
   "set" now works again
new feature:
   getfirstnames gets the dwarf first names rather than nicknames - can be combined with nicknames


2010.8.5 Major update: Linux version 0.11b released.
- bug fix on swapping floating points
2010.8.4 Major update: New version 0.11 released.

- Fixed bug occurring accessing names from a higher scope in a loop due to name stack popping incorrectly
- added bitwise operators(and, or, xor, left shift, right shift), modulo, independent stack pop and character value extraction from strings (needed for making a scanner function)
- included current main.ds which has functions for writing labours, attributes, traits and skills (as well reading the latter.)

2010.8.3 Updated: Added mental attributes and traits, and converted all names to lowercase, and spaces are now underscores

Spoiler: screenshots (click to show/hide)

When starting the program:

Getting the nicknames:

stop hauling those stones

Done!

After a couple of weeks of banging on the keyboard, I'm finally able to present to you a program that allows you to... well... pretty much anything, that you can script them to do

Initially, I only intended to make a DF therapist and runesmith replacement although it isn't really suppose to be a replacement, but for those who like text based interface rather than the GUIs of DF therapist and runesmith, this program is for you. I had a difficult time to a) find the right dwarf and b) find the right job on that huge spreadsheet of DF therapist and if you had the same problem, then this program is also for you. Because you can simply do:

Code: [Select]

urist mining onAnd urist will have his mining job activated. And when you're done, you can decativate it by typing:

Code: [Select]

urist mining offAnd if that's too much to type you can make a function:

Code: [Select]

(mining on)mine;and then:

Code: [Select]

urist minewill do the same thing as "urist mining on". Of course nothing prevents you from having "p" stand for "urist mining on"

At the moment the script still has limited functionality, but isn't as buggy as I thought it would be.
This is a checklist of things to do or are done:

1. more labours you can set [DONE]
2. attributes
 - physical [DONE]
 - mental [DONE]
3. traits [DONE]
4. skills [DONE]
5. preferences
6. looks
7. flags [DONE?]
8. etc.. (other dwarf properties)
9. the ability to set jobs of several dwarves at once (dwarf sets)
10. the ability to set several jobs at once (job sets)
11. having a dwarf automatically switch jobs at a regular interval
12. having a job set when a certain amount of an item is available
13. having a job unset when exp reaches certain lvl (e.g. to stop your supposedly civilian dwarf from training too much)
14 saving and loading your dwarf into a file, so you can play it in another fortress or in another version of df.
15. And more...

I would also appreciate any help making more scripts, ideas for new scripts, pseudocode for scripts if you can't bother learning postfix, and any information regarding how things are stored (non-creature stuff, as I have a fairly good picture of creatures) in df. Also feedback of any kind, positive and negative, would be appreciated,  and any suggestions for further developement.

Instructions:
1. Download DS for Windows or Linux
2. open the main.ds file in a plain text editor
3. copy and paste the following script (because I will be updating this often):

Spoiler: main.ds (click to show/hide)

Code: [Select]

($ 4 + read4 swap read4 - 4 /)count;
(4* swap read4 + read4)idx;
(24 + read4)strcap;
(20 + read4)strlen;

memoffset 0x0169575c +4+ df:

(0x001C +) nick;

0x07A0 soul:
(soul + read4)getsoul;
0x88 mattr:
0x04AC pattr:
0x0224 trait:
0x07BC labour:

0x087C happiness:
0x0114 id:
0x008C race:
0x00F8 flags1:
0x00FC flags2:
0x0298 birthyear:


0x0110 sex:
0x0088 profession:

0x07A0 likes:
0x01FC 4 + skills:

0x0 looks:

2 traitsize:
(getsoul 0   traitsize * trait + +)nervousness;
(getsoul 1   traitsize * trait + +)rage;
(getsoul 2   traitsize * trait + +)depression;
(getsoul 3   traitsize * trait + +)neurosis;
(getsoul 4   traitsize * trait + +)urge;
(getsoul 5   traitsize * trait + +)stress;
(getsoul 6   traitsize * trait + +)friendly;
(getsoul 7   traitsize * trait + +)company;
(getsoul 8   traitsize * trait + +)leadership;
(getsoul 9   traitsize * trait + +)activeness;
(getsoul 10   traitsize * trait + +)thrillseeking;
(getsoul 11   traitsize * trait + +)optimism;
(getsoul 12   traitsize * trait + +)imagination;
(getsoul 13   traitsize * trait + +)artistic;
(getsoul 14   traitsize * trait + +)emotion;
(getsoul 15   traitsize * trait + +)adventure;
(getsoul 16   traitsize * trait + +)thinking;
(getsoul 17   traitsize * trait + +)rebelliousness;
(getsoul 18   traitsize * trait + +)trusting;
(getsoul 19   traitsize * trait + +)honesty;
(getsoul 20   traitsize * trait + +)helpfulness;
(getsoul 21   traitsize * trait + +)compromising;
(getsoul 22   traitsize * trait + +)modesty;
(getsoul 23   traitsize * trait + +)compassion;
(getsoul 24   traitsize * trait + +)confidence;
(getsoul 25   traitsize * trait + +)organization;
(getsoul 26   traitsize * trait + +)lawfulness;
(getsoul 27   traitsize * trait + +)excellence;
(getsoul 28   traitsize * trait + +)perseverance;
(getsoul 29   traitsize * trait + +)cautiousness;

(getsoul 0   attrsize * mattr + +)analytical_ability;
(getsoul 1   attrsize * mattr + +)focus;
(getsoul 2   attrsize * mattr + +)willpower;
(getsoul 3   attrsize * mattr + +)creativity;
(getsoul 4   attrsize * mattr + +)intuition;
(getsoul 5   attrsize * mattr + +)patience;
(getsoul 6   attrsize * mattr + +)memory;
(getsoul 7   attrsize * mattr + +)linguistic_ability;
(getsoul 8   attrsize * mattr + +)spatial_sense;
(getsoul 9   attrsize * mattr + +)musicality;
(getsoul 10   attrsize * mattr + +)kinesthetic_sense;
(getsoul 11   attrsize * mattr + +)empathy;
(getsoul 12   attrsize * mattr + +)social_awareness;

0x1C attrsize:
(0 attrsize* pattr+ +)strength;
(1 attrsize* pattr+ +)agility;
(2 attrsize* pattr+ +)toughness;
(3 attrsize* pattr+ +)endurance;
(4 attrsize* pattr+ +)recuperation;
(5 attrsize* pattr+ +)disease_resistance;

0   Mining:
1   Wood_Cutting:
2   Carpentry:
49   Bowmaking:
3   Engraving:
4   Masonry:
5   Animal_Training:
6   Animal_Caretaking:
7   Fish_Dissection:
8   Animal_Dissection:
9   Fish_Cleaning:
10   Butchery:
11   Trapping:
22   Growing:
23   Herbalism:
57   Ambush:
71   Swimming:
72   Persuasion:
73   Negotiation:
74   Judging_Intent:
75   Appraisal:
76   Organization:
77   Record_Keeping:
78   Lying:
79   Intimidation:
80   Conversation:
81   Comedy:
82   Flattery:
83   Consoling:
84   Pacification:
85   Tracking:
24   Fishing:
25   Furnace_Operation:
26   Strand_Extraction:
67   Soap_Making:
68   Potash_Making:
66   Lye_Making:
65   Wood_Burning:
27   Weaponsmithing:
28   Armorsmithing:
29   Metalsmithing:
30   Gem_Cutting:
31   Gem_Setting:
32   Wood_Crafting:
33   Stone_Crafting:
34   Metal_Crafting:
35   Glassmaking:
86   Studying:
87   Concentration:
88   Discipline:
89   Observation:
90   Writing:
91   Prose:
92   Poetry:
93   Reading:
94   Speaking:
95   Coordination:
96   Balance:
97   Leadership:
98   Teaching:
99   Fighting:
100   Archery:
101   Wrestling:
102   Biting:
103   Striking:
104   Kicking:
105   Dodging:
38   Axe:
39   Sword:
41   Mace:
42   Hammer:
43   Spear:
44   Crossbow:
50   Pike:
52   Bow:
45   Shield:
46   Armor:
47   Siege_Engineering:
48   Siege_Operation:
70   Pump_Operation:
36   Leatherworkering:
12   Tanning:
69   Dyeing:
37   Bone_Carving:
13   Weaving:
14   Brewing:
16   Clothes_Making:
17   Milling:
18   Threshing:
53   Blowgun:
54   Throwing:
55   Machinery:
56   Nature:
40   Knife:
51   Lash:
21   Cooking:
15   Alchemy:
58   Building_Design:
19   Cheese_Making:
20   Milking:
106   Misc_Object:
59   Wound_Dressing:
60   Diagnostics:
61   Surgery:
62   Bone_Setting:
63   Suturing:
64   Crutch_walking:

(t. getsoul skills + s. 0 0 s count(1 - i. L. X. s i idx l. l read1 t == (l 4+ read1 l 8+ read2 0)(L X i)?)@ )readskill;
(X. L. t. getsoul skills + s. s count(1 - i. s i idx l. l read1 t == (l 4+ L write1 l 8+ X write2 0)(i)?)@ )writeskill;

(i. getsoul skills + i idx l. l read1 l 4+ read1 l 8+ read2)getskill;

0   labour+ mining:
1   labour+ stone_hauling:
2   labour+ wood_hauling:
3   labour+ burial:
4   labour+ food_hauling:
5   labour+ refuse_hauling:
6   labour+ item_hauling:
7   labour+ furniture_hauling:
8   labour+ animal_hauling:
9   labour+ cleaning:
10   labour+ wood_cutting:
11   labour+ carpentry:
12   labour+ stone_detailing:
13   labour+ masonry:
14   labour+ architecture:
15   labour+ animal_training:
16   labour+ animal_care:
17   labour+ diagnosis:
18   labour+ surgery:
19   labour+ setting_bones:
20   labour+ suturing:
21   labour+ dressing_wounds:
22   labour+ feed:
23   labour+ recovering_wounded:
24   labour+ butchery:
25   labour+ trapping:
26   labour+ small_animal_dissection:
27   labour+ leatherworking:
28   labour+ tanning:
29   labour+ brewing:
30   labour+ alchemy:
31   labour+ soap_maker:
32   labour+ weaving:
33   labour+ clothesmaking:
34   labour+ milling:
35   labour+ plant_processing:
36   labour+ cheese_making:
37   labour+ milking:
38   labour+ cooking:
39   labour+ farming:
40   labour+ plant_gathering:
41   labour+ fishing:
42   labour+ fish_cleaning:
43   labour+ fish_dissection:
44   labour+ hunting:
45   labour+ furnace_operating:
46   labour+ weaponsmithing:
47   labour+ armoring:
48   labour+ blacksmithing:
49   labour+ metalcrafting:
50   labour+ gem_cutting:
51   labour+ gem_setting:
52   labour+ woodcrafting:
53   labour+ stonecrafting:
54   labour+ bone_carving:
55   labour+ glassmaking:
56   labour+ strand_extraction:
57   labour+ siege_engineering:
58   labour+ siege_operating:
59   labour+ crossbow_making:
60   labour+ mechanics:
61   labour+ potash_making:
62   labour+ lye_making:
63   labour+ dyeing:
64   labour+ wood_burning:
65   labour+ pump_operating:

(+ 0 write1)off;
(+ 1 write1)on;

(n. + n write2)set;
(df count (1- i. df i idx l. l nick n. n strlen (l n readstl : )()? i)@)getnicks;
(df count (1- i. df i idx l. l nick n. n strlen (n readstl #)()? i)@)shownicks;


4. run ds.exe
5. type getnicks to read the nicks off your dwarves, note, you should set a nick on your dwarves or it can't handle them. Unless you make a script for that of course.
6. start using the various functions provided in the script, or just play around with the functions specified in the language reference. Available functions:
labours   
dwarf labour on
dwarf labour off
attributes
dwarf attribute value set

traits
dwarf trait value set

skills
dwarf  skillname  readskill
dwarf  skillname  skilllevel  experience  writeskill

7. when you're done, you type quit
You can also edit main.ds and add say labour 2+ whaul: (I am just guessing that wood hauling is the next. If it isn't, you can just change the name. I will have to write a reference on how exactly the script works. Its basically a reverse polish (postfix) notated language with a few other features I will have to explain.

Btw, I couldn't have done this without peterix and chmod whose code and memory offsets I've been studying, so special thanks goes to you guys.

Upcoming features for next version: more string related functions, sets and set manipulation, duplication visible in the debug print, and the ability to call functions defined within the same string being evaluated, thus also calling functions outside functions directly in main.ds such as getnicks. [/u]

[keda]

Language reference:

Short tutorial here

Dwarf script is written in Reverse polish notation which basically means that all functions are written backwards. If you're familiar with functional languages, where you write f a1 a2 a3, its basically the other way around: a1 a2 a3 f.
This also means mathematical and logical operators are written like a1 a2 f, rather than a1 f a2 which may seem a bit counterintuitive if you are not used to it. The benefit of this is that it simplifies the parsing and is also useful debugging expressions.


Arithmetic:

Arguments	Function	Return values	Description
n n	+	n	addition
i i	-	i	subtraction
i i	*	i	multiplication
i i	/	i	division
i i	%	i	modulo (rest of division)

Logic:

Arguments	Function	Return values	Description
i i	&&	i	and
i i	||	i	or
i i	!	i	not

Bitwise Logic:

Arguments	Function	Return values	Description
i i	&	i	bitwise and
i i	|	i	bitwise inclusive or
i i	^	i	bitwise exclusive or
i i	<<	i	bitshift to the left
i i	>>	i	bitshift to the right

Arithmetic logic:

Arguments	Function	Return values	Description
i i	>	i	greater
i i	<	i	smaller
i i	>=	i	greater or equal
i i	<=	i	smaller or equal
i i	==	i	equal
i i	!=	i	not equal

String:

Arguments	Function	Return values	Description
s	length	i	length
s s	+	s	concatenate
s i	strchar	i	get the char at given position from the string

Memory:

Arguments	Function	Return values	Description
i	read1	i	read 1 byte
i	read2	i	read 2 byte
i	read4	i	read 4 byte
i i	reads	s	read a character string (address, length => the read string)
i	readstl	s	read an STL string (address, the read string)
i i	write1		write 1 byte (address, 8 bit value to write*)
i i	write2		write 2 byte (address, 16 bit value to write*)
i i	write4		write 4 byte (address, 32 bit value to write*)

*) high bits are discarded e.g. 0x0fe21 => 0x0021 for 8 bit

Stack:

Arguments	Function	Return values	Description
x x	swap	x x	swap the two topmost elements
x	$	x x	duplicate top element
x	pop		remove top element

System:

Arguments	Function	Return values	Description
x	#		print (can also be used to pop, until i explicitely make that function)
s	eval		evaluate a string
s	load	s	load a file into a string
	functions		list all functions applicable to the current stack
	debug		enter/exit debug mode. This allows you to execute operations step by step
	memoffset	i	the memory correction needed to be added to the creature vector
	exit/quit/bye		terminate the program

In the above table:
s string
n number (integers or floating point values)
i integer (32 bit)
f floating point (32 bit)
x any of the above



Control structures:
boolean-expression(true-expression)(false-expression)? If/else
boolean-expression(iterative-expression  boolean-expression)@[/b] while loop

- boolean expressions are basically integers, that are false when 0 otherwise true, just like in C/C++.
- iterative-expression must take the arguments of type (x₀,x₁, ... , x_n, i) and yield (x₀, x₁, ... , x_n) so that the the head can be plugged into the tail so to speak.

Functions:
(multi or single value expression)string or identifier;
- defines a template function
- functions are actually created when first used. Each time you use a function with different argument types a new function is instantiated using the string defined, which resembles C++ template functions.

Variable Names:
single value expression  string or identifier.
- defines a local variable name
- these can only be used within the same scope or scopes defined inside of it, by one of the control structures.
- At the moment the value of these cannot be altered once defined, but this will change hopefully in the upcoming version.
single value expression  string or identifier: Define a global variable name
- these can be used and defined everywhere but will not be set until it is actually executed. Once set, its type cannot be altered although its value can be.

Constants:
integers are written as normal e.g: 234
floating point numbers are written with a . e.g: 2.1 or 1.0 (for some reason the windows version does not like floating points, it sometimes works sometimes not)
strings: "blah" also you can use
\\ for \
\" for "
\n for new line
\t for tab

[Viken]

Very interesting, Keda. I hope this works out!

[keda]

Thanks for your reply

Stay tuned, as I'll have more stuff coming, like settings the attributes and traits of your dwarves.

[Rumrusher]

wait does this mean we can get a adventurer's companion to dig, and build walls?

[keda]

Not yet, since I don't know where that data is stored, but if someone does, then that could be easily included. I'm aware there should be an array containing all world tiles and their designations that can be accessed. I'm thinking about using that later so you can check say the amount of items in a stockpile to activate a labour on a dwarf or one from a set of dwarves who are idle and have the skill etc. But of course anyone who knows can either write a script or describe how to access it here and I can make a script for it.

[Rumrusher]

Not yet, since I don't know where that data is stored, but if someone does, then that could be easily included. I'm aware there should be an array containing all world tiles and their designations that can be accessed. I'm thinking about using that later so you can check say the amount of items in a stockpile to activate a labour on a dwarf or one from a set of dwarves who are idle and have the skill etc. But of course anyone who knows can either write a script or describe how to access it here and I can make a script for it.

so your saying with a little bit of memory surfing we can designate areas for sentient beings to dig while in adventure mode... sweet!

[keda]

so your saying with a little bit of memory surfing we can designate areas for sentient beings to dig while in adventure mode... sweet!

Actually, I don't think you can do that just yet, unless Toady makes it a feature of adventure mode in the first place. But in fortress mode you could I suppose.

[keda]

Update:
It is now possible to set physical attributes like this:

Code: [Select]

urist strength 1500 set

[keda]

Update:
You can now also set mental attributes, in the same manner as physical attributes.
Also, traits have been added, which are also set using the same syntax

Note that traits range from 0-100 while attributes range about 0-2300

[Rumrusher]

two questions?
does this overwrite the class/job their in meaning one can get a noble/hero/child/baby to work as a miner with this?
can this work on any race?

[keda]

You can set nobles and children to work, no idea if it works on babies though. Race should also be irrelevant.

[keda]

A new version has been released since the script I've been working on didn't work due to a bug in the program. Surprisingly few (only one) encountered after the initial release, so I guess its not that buggy anymore. Fixing it, the script now works and:

It is now possible to read and alter your dwarves skills using the following functions:

dwarfname  skillname  readskill

Code: [Select]

urist Fishing readskill


dwarfname  skillname  skilllevel  experience  writeskill

Code: [Select]

urist Glassmaking 8 500 writeskill
Note: uppercase here, to distinguish from labours.

BTW a minor problem is that the skill must exist in order to be modified for now, but you can turn on a labour associated with that skill and you will have that skill the moment he starts working (or is finished with the first item or whatever) and then you can modify the skill. I'll see if I can make addition of new skills possible, but the problem is that the STL vector in DF would have to reallocate more space and I'm not sure if I can make it do that. One thing I could do is replace one skill with another.

Also given that the scripts for the first vector based dwarf property has been implemented, I should easily be able to add the other two(appearance and preferences) using the first as a template.

Also a bunch of new language features have been implemented, which allows for more sophisticated scripts to be made. check the original post for details and the language reference.

[NRN_R_Sumo1]

Wait, does this mean that I'll be able to script a dwarf to go fishing ONLY when there is no mining available, and if there are no fish available to then go on military duty at a pre-chosen station?

essentially prioritizing what our dwarves do, allowing there to be much less micro for small fortresses.

[keda]

Yes, once I have implemented a timer that you can script to call a particular function at a regular interval, and if you know where the designations (for mining) are stored you could do it. I suppose devek knows it because he has made a feature designating trees to be cut in dwarf foreman. As for the fish you can go through the creature vector using the idx (meaning index) and count (size of the vector) script functions and check the race. But yeah, the possibilites are endless, to make all those micromanagement tasks automated