Legend of Grimrock 2 Modding

[Sir Tawmis]

Creating Cinematics

You can play cinematics in Legend of Grimrock 2 mods using IVF-format for video and Ogg Vorbis for audio, which are played back in sync. Both of the formats can be created with free tools and we use Audacity for exporting Ogg and FFmpeg for IVF (although if you want to, FFmpeg should also be able to handle Ogg as well).

Let’s start off with the video. Once you have rendered your cinematic into a format that FFmpeg can handle (don’t worry, it should be able to use pretty much all common formats), we can convert it to video. FFmpeg is a command line tool so you need to either use command prompt in Windows or console on a Mac. Here’s a command that you can use as a starting point for converting your own video:

Code: Select all

ffmpeg -i c:\my_awesome_mod\cinematic.avi -vcodec libvpx -b 3000k -s 1280x720 c:\my_awesome_mod\cinematic.ivf

Modify the parameters to match the file names you want and feel free to modify the compression settings (“-b 3000k”) and resolution (“-s 1280×720”) as well if the cinematic ends up taking too much disk space.

For the audio, we just export a 44.1kHz stereo sound as Ogg Vorbis with a name that matches the name of the video. For example, if your video is named cinematic.ivf, name the Ogg-file cinematic.ogg.

After we have created the .ivf and .ogg files, place them into your “mod_assets\cinematics” -folder and then open the mod in Dungeon Editor. You can start the playback of a video with script so if we want a cinematic that automatically plays when the mod starts, all you need to do is to add a new script_entity into the level that the player starts in and add the following script there:

Code: Select all

GameMode.playVideo("mod_assets/cinematics/cine.ivf")

Note that you cannot play videos while in editor so you need to export and play the mod to see how the video works in practice.

Note for Legend of Grimrock 2 Version 2.1.18: When exporting, the editor does not currently package .ivf-files. To work around this limitation, rename your video file to .dds and update your script to match the new filename. This will be fixed in the next version.

[Sir Tawmis]

Grimrock 2 Asset Pack

This pack contains the original Legend of Grimrock 2 assets. You may use, modify and distribute these assets in Legend of Grimrock 2 mods. The redistributed assets must be contained in a package file (.dat file) generated by the Dungeon Editor. Any other use, commercial or non-commercial, for these assets is forbidden.

From time to time we may update the contents of the asset pack. Therefore you may not redistribute or mirror the asset pack or any of the assets contained within, except as packaged into a mod as explained above.

The full asset pack for modding has been released. The pack contains practically all scripts, textures, models and animation files of the game. Sound files are not included because their licensing terms don't allow redistributing them.

Please read the licensing terms below!

Download the asset pack 2 here:
https://drive.google.com/file/d/1Ex_OW5 ... drive_link

The custom file formats are explained here:
http://www.grimrock.net/modding/model-a ... e-formats/

How can I open model and animation files?

The model and animation files use custom file formats. Almost Human does not provide tools for opening and creating these file formats (we don’t have resources to support every 3D modeling software out there). Instead we provide specifications so that anybody can write importers/exporters for these formats. The specs can be found here: viewtopic.php?p=125598#p125598

Where are the wav files?

Unfortunately we don’t have rights to redistribute and let others modify sound files that we have licensed from a third party. You may still refer to the original Legend of Grimrock sound files contained in the main game archive from your scripts.


Modding and Asset Usage Terms

In order to protect the creators and players of mods, as well us at Almost Human and our brands, we need to set a few rules and terms regarding modding (creating custom dungeons, scripts and assets) for Legend of Grimrock 1 and Legend of Grimrock 2. We don’t want to discourage any modders from being creative but we do hope that you understand that we need a few common sense rules to keep the users of mods safe and that we need to define what we can consider fair use of our assets and intellectual property. We will try to keep these rules straightforward so that they would be easy to understand and to follow.

To put it another way, these rules are in place to make modding fair, fun and safe for all the parties involved:

- As a mod creator you need to acknowledge that Almost Human is not responsible for the contents of your mod and is not responsible if you create any mods that can be potentially harmful to the user or the user’s computer, or contain unlawful, offensive or obscene content.

- Running the mod must require an original copy of Legend of Grimrock 1 or Legend of Grimrock 2. Running the mod may not require, or perform, any modifications to the original game installation.

- You cannot charge money for your mod. Using voluntary donations or advertisements in moderation are acceptable on the websites used for distributing the mod but not within the mod itself.

- When creating mods, you are responsible for respecting the intellectual property (copyrights, trademarks) of companies and individuals, including other modders. You, of course, retain the copyright to your own original creations and mods and you are free to use the parts of said mods that you have created yourself for other purposes too (commercial or non-commercial) as long as it does not interfere with their use in the mod.

- Do not do anything that might lead people into thinking that your mod is an official Almost Human or Legend of Grimrock product or that the mod is officially endorsed by us or affiliated with us.

- To make sure that we have full freedom to develop games, we would like to emphasize that we retain the rights to use any ideas from mods. This doesn’t, however, mean that we are interested in harvesting ideas from mods but that our possibilities to further develop Legend of Grimrock or similar games would be severely limited if we couldn’t use any ideas similar to those found in mods.

- We may use footage and/or screenshots from any published mods for promoting Legend of Grimrock.

- You may only modify or redistribute those original or modified Legend of Grimrock game assets (this includes, but is not limited to, software, code, Lua files, graphics, writing and audio) that we have explicitly released for creating Legend of Grimrock mods. The redistributed assets must be contained in a package file (.dat file) generated by the Dungeon Editor. Any other use, commercial or non-commercial, for these assets is forbidden. From time to time we may update the contents of the asset pack. Therefore you may not redistribute or mirror the asset pack or any of the assets contained within, except as packaged into a mod as explained above.

- We reserve the right to revise these rules at any time, with immediate and retroactive effect.

Thank you for reading, we hope these rules are sensible. And remember, you can always ask: if you have a project where you are not certain how it works in light of these rules, we urge you to contact us instead of just going ahead and releasing it by yourself.

And that’s it, have fun modding!