Modules

Modules At a Glance

A Module is a legacy tool that is used to influence how our older models focus on specific styles, genres, or settings. Also to draw upon specific topics, emulate writing styles, or to work upon reference material.

Custom Modules are only available to use with the older models Sigurd and Euterpe. Training of new custom Modules is no longer supported, but you can still use existing custom Modules.

Using a Module

Selecting a Module

With a Story selected from the Library Sidebar and open in the Editor, you can select a Module under in the ‘Story’ tab of the Options Sidebar, under AI Module, which makes it the Story’s active Module for generating text. This is presented as a dropdown selection, but clicking on All Modules just above the dropdown box will take you to the AI Modules Gallery.

The AI Modules Gallery

Presented as a grid of cards separated into the sections Imported, Specials, General, Style, Theme, and Inspiration, the AI Modules Gallery is where you can quickly browse all the Modules available for a given AI Model alongside each Module’s Description and Thumbnail Images. The Imported section of the Gallery is where all your Custom Modules live. The rest of the sections are where The Provided Modules live!

The Provided Modules

The Specials section is reserved for Modules ‘with extra functionality’, which is where you can find the Text Adventure Module. The General section is where you can find the option to use No Module with your Story, or use the Cross-Genre Module, which is suitable for a wide variety of story subjects. The Style section is home to Modules which encompass material from specific, iconic writers. The Theme section is the largest, and offers a large selection of Modules which bundle together lots of material from their stated literary genre. The Inspiration section is much like the Theme section, but instead has Modules which choose to sample a much narrower body of work so that their outputs are more specific and focused.

Text Adventure

This Module is listed under Specials due to the fact that it changes the appearance of the Editor to a Text Adventure interface! In brief, this Module’s training data is entirely written in second person (using “You” for all sentences), and has distinct ‘Player Actions’ denoted by the > character. For more details on Text Adventure Mode, you can check out its [documentation article](Matty’s Page Here).

Advanced: Custom AI Module File Tweaks (Deprecated Functionality)

Note: Custom AI Modules have been deprecated, however if you have a Custom Module file you can still implement these changes for your personal enjoyment.

Images for Custom Modules

You might have noticed while browsing the AI Modules Gallery that the Provided Modules have stylish thumbnail images, while custom Modules all share the same pile-of-treasure image by default. Thankfully there’s a way to change that! It’s just not officially supported in the UI, and requires use of a text editor. Just Notepad works fine, but Notepad++ or VS Code can make .Module files faster to browse and easier to read. Open your downloaded .Module file in the text editor of your choice, and scroll to the very bottom. There you should see a few lines which look like

],
"mode": 0
}

Add a line after ‘mode’ so it looks like this:

],
"mode": 0,
"image": "<image>"

Then upload your desired Module thumbnail image to whatever hosting site you like, (imgur, for example), and paste the image link where the <image> placeholder is in that example above. So, your finished line should like:

],
"mode": 0,
"image": "https://i.imgur.com/yourmoduleimagehere.png"

Text Adventure Mode for Custom Modules

If you have a custom Module that’s meant to change the AI’s outputs to behave like an interactive Text Adventure, you can also make it so that your Module changes the Editor UI to the Text Adventure UI when it’s selected! Thankfully it’s as easy as changing the “mode” line we just talked about above from 0 to 1.

Make sure you save your Module file after making any changes, and re-import it to NovelAI!