Bay 12 Games Forum

Dwarf Fortress => DF Modding => Mod Releases => Topic started by: Meph on August 21, 2015, 01:29:50 pm

Title: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: Meph on August 21, 2015, 01:29:50 pm
(http://i.imgur.com/TrV6sTK.png)

What does it do?
The great archive is a workshop that allows your dwarves to open Legends-Mode while playing Fortress-Mode. This way you can read up on the world you created, without closing the game and fiddling with your safe files.

>>> Download <<< (http://dffd.bay12games.com/file.php?id=11070)

How does it work?
You will notice a new workshop in your build-menu: "Great Archive". You need 4 golden statues and 1 platinum cabinet for it; it's build by any architect. It has one job: "Read the legends of this world", which opens legends mode; the job requires no skill, is finished instantly and can be done by any dwarf.

(http://i.imgur.com/fGHCnom.png)

How do I install it?
You drag and drop the hack and raw folder from the download into your DF installation; you need the newest DF, 40.24, and dfhack. Now you have the script and the files; but you still need to teach your civilization to build the workshop and let dfhack know when to ues it.

Open your DwarfFortress/raw/objects/entity_default.txt and add these lines to your dwarven civilization:
[PERMITTED_BUILDING:GREAT_ARCHIVE]
[PERMITTED_REACTION:OPEN_LEGENDS]

Open your DwarfFortress/raw/onLoad.init and add this line to it:
modtools/reaction-trigger -reactionName OPEN_LEGENDS -command [ open-legends ]

That's it!

Do I need to gen a new world?
Yes, you do.

Credits:
 - Mifki: the initial dfhack lines.
 - Lethosor: the open-legends script.
 - Meph: Workshop and reaction.

PS: Had a tiny strange mood, thought this would be a neat idea after I read the forum post about the script. Hope you enjoy the little bit of immersion that it gives. If the gold/platinum items are too much trouble, you can always open legends mode by simply typing "open-legends" (without "") into the dfhack console.

Cheers,
Meph
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: Meph on August 21, 2015, 01:40:49 pm
Reserved for stuff, for example asking PeridexisErrant if you want/need this for the StarterPack. :P
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: Teneb on August 21, 2015, 03:46:16 pm
Meph, I'd suggest changing it so it's any old cabinet instead. Platinum is hard to come by.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: Meph on August 21, 2015, 04:05:12 pm
Meph, I'd suggest changing it so it's any old cabinet instead. Platinum is hard to come by.
Which was the intention. I'll add a poll.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: vjmdhzgr on August 21, 2015, 04:20:43 pm
This is fantastic. Has it been tested sufficiently? This sounds like the kind of thing that would crash a lot.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: Meph on August 21, 2015, 04:37:46 pm
This is fantastic. Has it been tested sufficiently? This sounds like the kind of thing that would crash a lot.
I tested, no crashes. As far as I know, PeridexisErrant even added the script to the StarterPack.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: mifki on August 21, 2015, 07:26:36 pm
Meph, I'd suggest changing it so it's any old cabinet instead. Platinum is hard to come by.
Which was the intention. I'll add a poll.

That would be fine if you couldn't just call the script from console, but since you can anyway, I don't think it should be that hard to build.
Also, when thinking of archive, I imaging something.. not shiny gold and platinum:)
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: PeridexisErrant on August 21, 2015, 10:41:45 pm
Looks great! 

I certainly like the idea, though if you want to build up a Starter Pack mini-mod collection (yes please) there's some formatting issues for best results with PyLNP.  Here's (https://www.dropbox.com/s/iops405qi5l2dym/The%20Great%20Archive.zip?dl=0) the reformatted version.  Details on the mod format are available here (https://bitbucket.org/Pidgeot/python-lnp#rst-header-graphics); the short version is that any changed files should be included changed, you should use a manifest.json, and only stuff under raw/ (and data/speech/) will be used.  I'm happy to help out if you're interested, and/or explain exactly why that format was chosen.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: boogiemanspud on August 21, 2015, 10:52:41 pm
I agree, platinum seems too hard to get.  I think it would be more useful to be able to be made from cheaper materials.  I think it's more important for a mod like this to be accessible.  Putting artificial barriers on it just means it won't get used or be as useful.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: Meph on August 22, 2015, 01:46:52 am
Looks great! 

I certainly like the idea, though if you want to build up a Starter Pack mini-mod collection (yes please) there's some formatting issues for best results with PyLNP.  Here's (https://www.dropbox.com/s/iops405qi5l2dym/The%20Great%20Archive.zip?dl=0) the reformatted version.  Details on the mod format are available here (https://bitbucket.org/Pidgeot/python-lnp#rst-header-graphics); the short version is that any changed files should be included changed, you should use a manifest.json, and only stuff under raw/ (and data/speech/) will be used.  I'm happy to help out if you're interested, and/or explain exactly why that format was chosen.
I know; that's why I asked. Before I make the extra work, I wanted to double check if you even wanted to have it.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: lethosor on September 01, 2015, 08:13:14 am
I agree, platinum seems too hard to get.  I think it would be more useful to be able to be made from cheaper materials.  I think it's more important for a mod like this to be accessible.  Putting artificial barriers on it just means it won't get used or be as useful.
You can always use the script directly (or bind it to a key).

This is fantastic. Has it been tested sufficiently? This sounds like the kind of thing that would crash a lot.
Yeah - that's why the script is 60 lines (currently) instead of 1.

By the way, I just discovered that this script breaks the help key, so I pushed a fix for that (repo (https://github.com/lethosor/dfhack-scripts)). It's not a major issue, since the default screen is the same help screen you'd typically find in fortress mode (which isn't actually what you'd see in reclaim or adventure mode), but it's better than doing nothing.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: Timeless Bob on September 15, 2015, 07:06:41 am
This is AWESOME!
OK, so I have this crazy idea about book content that involves reading parts of Legends mode and now with this tool, that crazy idea is a little less impossible.

My idea is that a book's title creates a quick search of legends mode pertaining to the subject of the title.  However many pages of the book = the number of lines from a random point that is included in the book as content.  Generally, a book would start at the beginning of whatever subject was in the title and if there was more to the subject than the book had "pages", then the next book to be written about that subject would become "volume II" in the set and pick up where the last one left off.  This way, all those books written by necros and demons would all link to actual pre-generated content.  What would be very interesting, is that only those parts of history that book-writers wrote about would become knowable history, except by carvings, statues or tombstones. 
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: Bosa on September 15, 2015, 11:51:28 am
Just an idea, but what about expanding the plant fiber industry to make paper in addition to cloth, and then using a significant amount of paper plus standard building materials to construct the archive. Possibly adding one more step if that isn't difficult and adding things like books and scrolls made from paper as building items instead. Also, and I'm not sure if this would be possible or not, but make two separate jobs for the archive, the first for recording legends, and the second for reading legends. The first would require either paper or book/scroll, depending on the difficulty you're looking for, and the second would be the same as it is now, with the exception that it shows you the state legends was in when it was last recorded. This would make building and maintaining the archive somewhat difficult while still allowing it to be built on every map, since I'm pretty sure you may not always get access to gold and platinum.

Some other ideas:
+Use plant or silk cloth instead of paper.
+Bind books with leather.
+Wrap scrolls around wood logs, or a new craft item.
+Use dye in the recording.
+Have recording legends train record keeper.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: PeridexisErrant on September 15, 2015, 06:03:04 pm
... It sounds like you want to implement a big chunk of the forthcoming DF version within a month or two of release. It's an interesting idea, but I'd wait until all that is natively supported.
Title: Re: The Great Archive - minimod that lets you open legends mode from your fortress
Post by: qorthos on September 16, 2015, 03:21:06 pm
Hard is fine for masterwork, where we have Alchemy and Religion and can get any metal we desire with a bit of work.  Seems a bit rough for a regular game though.  It would only be available with trading for most embarks.