[Doc] How to make a LifePlay mod?

[Raddeck]

Today I'm going to show you how to make a mod.

What is a mod?
Modules modify or extend the game. Every module will be loaded and parsed by LifePlay if enabled.


So let's start:
First of all, imagine you made a story, so you created 10 lpscenes and 5 lpactions files.
I want to call my mod "My First Mod"


1- Create a new folder in "C:\...\LifePlay\Content\Modules".
Call it: rk_My_First_Mod
Result : "C:\...\LifePlay\LifePlay\Content\Modules\rk_My_First_Mod"

Why rk_ in the first place?
It's the initials of my modder's name that I add to my mods/files, to allow me to better help my users when they find bugs and for other reasons. You don't have to, but it is recommended...
So if your name is PrettyBastard, you can call your folder "pb_My_First_Mod".


2- Now open Notepad++
Create a file called "pb_My_First_Mod.lpmod"
In this file, add this:

Code: Select all

MODULE_UNIQUEID: pb_My_First_Mod
MODULE_NAME: //Add the title of your mod
MODULE_AUTHOR: //Add your name
MODULE_LINK: //Add a link to your mod page or leave empty
MODULE_DESCRIPTION: //Add a description for your mod
MODULE_REQUIREMENTS: //Add requirements or leave empty
MODULE_VERSION: //Add your mod version number

3- Then, in the folder C:\...\LifePlay\Content\Modules\rk_My_First_Mod
You will need to create more folders if needed.
Actions : For your lpaction files
Scenes: For your lpscene files
Stats: For your lpstat files
World: if you have any backgrounds(lpworld)
Add all the files you have created to the corresponding folder.


4- Congratulations, you have created your first mod!