View source for Modding

{{AlertInfo|This page was last updated as of Summertime Saga v0.18.0}}

= Summertime Saga's API =

{{AlertWarn|The API for Summertime Saga is currently under development, and this page is subject to many changes}}

== FSMs (Finite State Machines) ==

'''Finite State Machines''' control the flow of the game for a particular character. They are basically linked chains of events (which are called '''States'''). The progress is achieved via a '''Trigger'''.

[[File:Fsm1.png|thumb|800px|center|A basic example of a FSM]]

=== Creating a FSM ===

Creating a FSM is done in 3 steps:

# Create the states, triggers and a machine instance, providing the necessary arguments to each constructor. Triggers should be created in an init python block of priority 0 or later.
# Link the states together with <code>State.add(Trigger t, State next_state)</code> method.
# Add all the states to the machine with <code>Machine.add(*State states)</code> method.

State and machine definition and state linking should be done in a label named <code>character_fsm_init</code>, whith <code>character</code> being the character's name. Additionally, further edits to the machine (such as adding the states) should be done in a label named <code>character_machine_init</code>, with <code>character</code> being the name of the character.

==== Machine specific ====

The machine constructor has plenty of arguments, here is the detail and what is expected:

; name : A name for the machine. Is used as a unique identifier for the machine. Will also be used to find the button dialogue for that machine.
; default_loc : A 4x7 matrix of locations to be used as the "schedule" for where a given machine should be at any point during the week. A 4x1 or 2x4 matrix may be passed as well, and internally will be converted to a 4x7 matrix. If a 1x4 matrix is passed, it is assumed that the location only varies by time of day, and the day of the week doesn't matter. A 2x4 matrix will split the two, the first 4-list is for weekdays, and the second for weekend days.
; description, states : (to be deprecated) An alternate ways to add states to the machine, and a description that is never used anywhere.
; vars : A dictionary containing variables (as strings, the keys of that dictionary), and init values for those variables. These variables are used with the [[#State actions|state actions]] and the <code>get(string variable)</code> and <code>set(string variable, object value)</code> methods of the machine class. When a specific state doesn't apply, or you need a variable to change based on the progress with a given path. The <code>sex speed</code> variable is assumed to be used only for setting the speed of the animation for sex scenes.

The machine class defines a lot of useful methods:

; set_priority(int priority) : Set the priority of the machine. Currently used to display the hints on the phone. A machine with a priority of 1 or more will show up in the phone. Later, this may be used to sort quests into main quests and side quests.
; property button_dialogue : Return the button dialogue for that machine (<code>machine name</code> + <code>_button_dialogue</code>), used in the TalkTo screen action.
; image, show, say, and hide : Now defunct methods.
; property progress : Return an integer that is the progress out of a 100%.
; add_action(*actions) : Add a machine action to this machine.
; set_state(State state, bool null_delay=False) : Revert the machine to init, then advance the machine until it is in the state '''state'''. If <code>null_delay</code> is True, then set the delay of the state reached to 0.
; machine_trigger : Trigger for machine actions.
; trigger(Trigger trigger, bool noactions=False) : Trigger the machine to pass onto the next state. If <code>noaction</code> is True, don't process the actions.
; add(State* states) : Add the states to the machine.
; get(string var), set(string var, object value) : Get and set the machine variable var.
; get_state() : Return the state the machine is in.
; property where : Compute where the machine should be based on her default location, time of day, day of the week, forced location and if it's forced or not for that time of day. Return a location.
; is_state(State* states), between_states(State stateBegin, State* statesEnd), finished_state(State* states) : Return boolean if the machine is in any of the provided states, between <code>stateBegin</code> and any of the <code>statesEnd</code> (non inclusive), and if the machine has finished any of the states provided, respectfully.

==== State specific ====

At state creation, you may want to add a delay to it using the delay optional argument. That delay is the number of days until that state is effectively reached once the trigger has been "pulled".

When linking states together, you may want to add '''state actions''' to be executed when the state is triggered. Those actions are:

; ['set','flag_1'] : Set the value of <code>flag_1</code> to True.
; ['clear','flag_1'] : Set the value of <code>flag_1</code> to False.
; ['toggle','flag_1'] : Toggle the value of <code>flag_1</code> between True and False.
; ['assign',['v1',100]] : Set the value of <code>v1</code> to 100.
; ['inc','v1'] : Increase the value of <code>v1</code> by 1.
; ['dec','v1'] : Decrease the value of <code>v1</code> by 1.
; <nowiki>['triggeronzero':['v1',T_a_trigger]]</nowiki> : Set <code>v1 -= 1</code> and if v1 <= 0 it will fire the trigger <code>T_a_trigger</code>.
; ['trigger',T_a_trigger] : Fire the trigger <code>T_a_trigger</code>.
; ['call','label'] : Make a Ren'Py call to label. Label MUST return.
; <nowiki>['location', [machine, {"tod":tod, "place":place}]]</nowiki> : Set the forced location for the machine to place (moves the non-player character).
: <code>tod</code> is 1-indexed (1 is morning, 2 is afternoon, 3 is evening, 4 is night).
; <nowiki>['force', [machine, {"tod": list or int, "flag": 4-list or bool}]]</nowiki> : Say if the location is forced at tod or sets force flags according to the 4-list provided.
; ['unforce', None/machine] : Unforce the locations for machine or the machine specified forced.
; ['exec', callable] : Call the callable function or method.
; ['exec', [callable, *args]] : Call the callable and pass in the args specified.
; ['condition', [condition_string, actions_list_true, actions_list_false, (optional) machine]] : Execute the actions in <code>actions_list_true</code> if <code>condition_string</code> evaluates to True, otherwise executes <code>actions_list_false</code>. Conditions lists are assumed to be state actions.
; ['action', [target_machine, action, target]] : Execute the state action on another machine.
; <nowiki>['setdefaultloc', [[Location, Location, Location, Location]]]</nowiki> : Set the default locations for the current machine.
: The argument is in the same format as the <code>default_loc</code> argument in the machine constructor (1x4, 2x4 or 7x4 matrices).
; ['setoutfit', [location, outfit]] : Set <code>outfit</code> for that location. <code>outfit</code> may be either a string, or a 1x4, 2x4, 7x4 array of strings (similar to the locations).
; ['setnaked', True/False] : Set <code>is_naked</code> attribute of the current machine's [[#Outfit manager|outfit manager]] to True/False
; <nowiki>['setdefaultoutfit', [outfit, {'tod':tod, 'dow':dow}]]</nowiki> : Set the current machine's default <code>outfit</code>.
: <code>tod</code> and <code>dow</code> can be omitted. <code>outfit</code> is a required argument, can be a string or a 1x4,2x4,7x4 matrix.
: If <code>tod</code> and <code>dow</code> are omitted, <code>outfit</code> cannot be a matrix, but only a string. A workaround solution exists by passing the <code>{"tod":None, "dow":None}</code> dictionary.

=== Editing an FSM ===

Editing a currently existing FSM is actually as simple as calling the <code>clear()</code> method of the state you want to clear. It takes one argument, cleardelay, which defaults to False. If cleardelay is True, then the delay of the state will be cleared. If you don't want to edit the state, but just want to clear the delay, you can just set the State.delay attribute to 0 instead.

Once cleared, the state will be unlinked to the rest of the FSM, which means that story will block at that state, it's then up to you to link that state to the rest of the machine, with addtionnal states in the middle for your code.

=== Using FSMs ===

Using FSMs is suprisingly easy. In your location labels, you can just test the state a machine is in with <code>is_state(State* states)</code> method. Multiple states may be passed in that method, as well as a list of states. If the machine is in any of the provided states, then the method will return True, and False otherwise. For convenience, other similar methods can be used. <code>between_states(State state1, State state2)</code> will return True if the machine is in any state between <code>state1</code> and <code>state2</code> but is not in state <code>state2</code>. <code>finished_state(State* states)</code> will return True if the machine has finished any of the provided states.

To advance to the next state, <code>trigger(Trigger t)</code> method of the machine class is used. It will advance the machine to the next state associated with that trigger if the provided trigger is in the current state's table, and won't do anything otherwise.

=== Example of an FSM ===

<syntaxhighlight lang="Python">
init python:
    T_cassie_ban_mc = Trigger("ban mc")
    T_cassie_lift_ban = Trigger("lift ban")
    T_cassie_drowning = Trigger("drowning")
    T_cassie_end = Trigger("end")

label cassie_fsm_init:
    python:
        # Cassie's States
        S_cassie_start = State("start")
        S_cassie_ban_from_pool = State("ban from pool", "You should go to the pool at night...")
        S_cassie_caught_skinny_dipping = State("caught skinny dipping", "Cassie lifted your ban! Go for a swim!")
        S_cassie_medic_room = State("medic room", "Have fun in the medic room...")
        S_cassie_end = State("end")
        
        # Build out Cassie's FSM
        S_cassie_start.add(T_cassie_ban_mc, S_cassie_ban_from_pool)
        S_cassie_ban_from_pool.add(T_cassie_lift_ban, S_cassie_caught_skinny_dipping)
        S_cassie_caught_skinny_dipping.add(T_cassie_drowning, S_cassie_medic_room)
        S_cassie_medic_room.add(T_cassie_end, S_cassie_end, actions=["exec", A_drowning_in_pussy.unlock])
        
        M_cassie.add(S_cassie_start, S_cassie_ban_from_pool,
                     S_cassie_caught_skinny_dipping,
                     S_cassie_medic_room, S_cassie_end)
    return

label cassie_machine_init:
    python:
        M_cassie = Machine("cassie", default_loc=[[L_pool, L_pool, L_pool, L_NULL]],
                         vars={'sex speed': .3,
                               'had sex': False},
        )
    return
</syntaxhighlight>

At init time, all the triggers are created. It's important that triggers be created at an init time of '''0 or later''', sine the Trigger class is defined in an init -2 python block, and other parts of FSMs in an init -1 python block.

On starting the game, and on loading a save file or reloading the game, the states are created and linked together, but after the machine itself is initialized. In the above example, here is the order :

'''init (triggers)''' > '''call (after_load/start)''' > '''call cassie_machine_init''' > '''call cassie_fsm_init'''

In the example, the machine is named "M_cassie" and is given the name "cassie". This name is used in several places throughout the code to refer to that object. Furthermore, her default location (<code>default_loc</code> argument) specifies that she will be in the pool from morning to evening, and nowhere in the night. A dictionary is initialized as well, to keep track of some other variables, like for instance, the sex speed for the animations, whether or not the character had sex with that character, variables to trigger repeatable dialogues, counters etc.
In the same label, you can also set up the outfit system of that character, as seen in the next section, or add machine actions to the FSM. This is also the place to set the priority of the FSM.

In the <code>cassie_fsm_init</code> label, you're supposed to create your states, and link them together. As you can see, the last link has a state action attached to it, which means that on reaching the <code>S_cassie_end state</code>, the machine will automatically call the unlock method of the '''A_drowning_in_pussy achievement'''. In the same way, other state actions may be defined.

<u>'''Other examples from the game:'''</u>

<syntaxhighlight lang="Python">
        S_diane_drunken_splur.add(T_diane_help_carry_to_bed, S_diane_get_cold_towel,
                                  actions = ["location", {"place": L_diane_bedroom},
                                             "force", {"tod": [0,1]},
                                             ]
                                  )
        S_diane_milking_help.add(T_diane_milking_malfunction_help, S_diane_debbie_evening_visit,
                                 actions = ["location", {"place": L_home_kitchen,
                                                         "condition": "not M_diane.is_set('first cucumber')",
                                                         },
                                            "force", {"tod": 2},
                                            ]
                                 )
</syntaxhighlight>
<syntaxhighlight lang="Python">
        S_diane_look_in_kitchen.add(T_diane_search_kitchen, S_diane_seen_cucumber,
                                    actions = ["action", [M_player, "set", "jerk diane"]
                                               ]
                                    )
</syntaxhighlight>
<syntaxhighlight lang="Python">
        S_diane_fetch_pump.add(T_diane_found_pump, S_diane_delivery_2_task,
                               actions = ["setdefaultloc", [[L_diane_shed, L_diane_shed, L_diane_shed, L_diane_bedroom]]]
                               )
</syntaxhighlight>

=== Outfit manager ===

Every FSM has an '''outfit manager''' instance attached to it. The outfit system is designed a bit like the Location system, in that each outfit has a specific time of day/day of week schedule for which the character is wearing that outfit. In addition, the outfit manager also takes into account the location the player is currently in. The outfit manager also handles whether the character is naked or not, with the <code>is_naked</code> attribute.

To bind an outfit "schedule" to a location, use the method <code>bind_outfit_to_location</code>, with the arguments being first, the location and second the outfit string/schedule.

An outfit schedule is very similar to a Location schedule, it's a 1x4/2x4/7x4 matrix of strings, each of those strings being the outfit of a given pair of time of day/day of week.

'''Init arguments:'''

; default_outfit : Defaults to <nowiki>[["dressed", "dressed", "dressed", "dressed"]]</nowiki>
; is_naked : Defaults to False

'''Methods and attributes:'''

; default_outfit : The outfit schedule that will be used if the character is in a location that does not have a table of outfits for that character.
; is_naked : Boolean that tells if the machine is naked or not.
; bind_outfit_to_location(Location location, object outfit_schedule) : Will bind the given outfit schedule to the given location. The outfit schedule may be one of the following: a string, a 1x4 matrix, a 2x4 matrix or a 7x4 matrix of strings.
; format_outfit_schedule(object outfit_schedule) : Format the outfit schedule to a 7x4 matrix of strings. Used internally.
; property get() : Return the proper outfit given the current time of day, day of week, whether the machine is naked or not and player location.

{{AlertInfo|Below is a copy-paste from discord, I'm gonna rewrite it at some point, it gets the point accross though.}}

So basically how the new outfit system works
you have to setup the outfit manager. The outfit manager has one method called <code>bind_outfit_to_location</code> that takes 2 arguments : location (a Location object) and outfit (which can be an outfit string, or an outfit schedule ie a matrix just like the locations)
so what you do is use that method to create basically a map of outfits to use in certain conditions
moreover, outfits can be set with a simple state action, which takes care of calling the <code>bind_outfit_to_location</code> method
also, now, to get the outfit, it's as simple as calling <code>M_diane.outfit.get</code>
(without any parentheses, get is a property of the outfit manager)
the <code>is_naked</code> variable has also been moved to the outfit manager, because it's cleaner

instead of M_diane.get_naked_str, you use M_diane.outfit.get
instead of doing M_diane.outfit = "whatever" you must configure the outfit manager
M_diane.outfit.bind_outfit_to_location(L_home_livingroom, "casual")
if you want more granularity, you can do this
M_diane.outfit.bind_outfit_to_location(L_home_livingroom, <nowiki>[["dressed", "dressed", "casual", "casual"]]</nowiki>)
you can even set that matrix to bean individual outfit for each time of day, each day of the week
as for the state action, there is "setnaked" and "setoutfit"
setnaked will set the machine to be naked or not, thing you can also do with M_diane.outfit.is_naked = True / False
True /False not True over False, it's not a division
and setoutfit just calls the bind_outfit_to_location method with the two arguments you specify, like so
actions=["setoutfit", [L_home_livingroom, "casual"]]
the Machine.outfit.get property works like that:

<syntaxhighlight>
if the machine is naked
    return "naked"
otherwise if the player is in a location the outfit manager is not bound to
    if the outfit to be returned is "naked", set the is_naked attribute to True, and False otherwise
    return default_outfit for that day of week and time of day
otherwise
    if the outfit to be returned is "naked", set the is_naked attribute to True, and False otherwise
    return outfit for that location at that day of week and time of day
</syntaxhighlight>

Use <code>del M_diane.outfit.outfits[L_home_livingroom]</code> to revert back to the default if needed.

=== Pregnancy Manager ===

== Locations ==

'''Locations''' handle all the locations in the game. They are represented as a tree, with the possibility of multiple parents (like Smith's Bedroom, which has the front yard and the hallway as its parents). A required attribute is the location name.

=== Creating a location ===

Locations are very simple to create. It's as simple as instanciating the Location class, and providing a name for that location to the contructor (which is the only required argument). Locations are mutable, so they should be instantiated in a <code>modname_locations_init</code> label.

Furthermore, Locations have several optional arguments:

; name : The name for that location, as can be seen in the top-left corner of the screen. It's also the way to find and call the relevant location screen, as well as the location label.
; unlock_popup : The name of a Ren'Py-defined displayable for the popup that should show up when the location is unlocked.
; background : The name of the background used for that location. The background name must follow several conventions to work properly:
:* Must be in the folder <code>images/backgrounds/</code>
:* Name must start with <code>location_</code>
:* Name must end with <code>_day.jpg</code>, <code>_evening.jpg</code> or <code>_night.jpg</code>,  respectively for day, evening or night background.
:* For halloween or christmas backgrounds, the strings <code>_halloween</code> and <code>_christmas</code> must be added before the time of day code. This will allow the game to find relevant backgrounds for the time period.
: Whatever is leftover should be provided in the background argument of the constructor. The full file path will be constructed by the background (resp. background_blur) properties.
; parents : Either a list of location or a single location instance. Will provide the parents of that location. If left empty, the location is assumed to be the root of the tree. The root should always be <code>L_map</code> (or <code>L_NULL</code>, but <code>L_NULL</code> should not have children).
; locked : Defaults to False. Whether the Location should be initially locked, and unaccessible at the beginning of the game.
; label : (to be deprecated) The label name for that location. the formatted_name property will be used later on.

<u>'''Example:'''</u> <syntaxhighlight lang="Python">L_diane_barn = Location("Diane's Barn", unlock_popup="popup_diane_barn", background="barn_frontyard", parents=L_map, locked=True)</syntaxhighlight>

This code defines a location named "Diane's Barn" (formatted name: <code>dianes_barn</code>), child of <code>L_map</code>, that shows <code>popup_diane_barn</code> on unlock, and that is initially locked. The background is set as <code>barn_frontyard</code>, which means the game looks for files named <code>backgrounds/location_barn_frontyard_day.jpg</code> or <code>backgrounds/location_barn_frontyard_night.jpg</code> for instance.

== User-defined screen actions ==

The '''screen actions''' are specific to ''Summertime Saga'' and should be used to keep the flow consistent.

=== MoveTo ===

This action expects a location to be passed. It will hide the current screen, move the player to that location, and call the corresponding screen as well as jump to the location label

=== BuyItem ===

This action expects an item, or item identifier string to be passed to it. When activated, will buy the item, and show the appropriate failing popups should the transaction fail. Optionally, you may add a callback label with the <code>callback_label</code> optionnal argument. If the transaction succeeds, the game will then call that label (useful if you want some story element to trigger after buying an item).

=== TalkTo ===

To be used to talk to character. Will hide the screen and start the conversation with the given character. It expects a machine instance, or a string to identify it, in which case it will attempt to find the machine in the store.machines dictionary.

=== ClearPersistent ===

Will reset the player's persistent data (cookie jar, time spent playing, achievements etc). No arguments expected.

=== GetItem ===

Will get the item, and attempt to show the corresponding popup. No arguments required.

== JSON Data ==

=== Items and inventory management ===

The '''inventory manager''' is fully automatic, but you may want to add some items to the game. Items are stored in <code>items.json</code> file located in <code>scripts/data/folder</code>.

<u>'''Example:'''</u>

<syntaxhighlight lang="json">
"birth_control_pills": {
    "id": "173",
    "name": "{b}Birth Control Pills:{/b}",
    "cost": "0",
    "image": "objects/item_pills3.png",
    "description": "Makes you temporarily sterile.",
    "closeup": "",
    "dialogue_label": "birth_control_pills",
    "popup_image": ""
}
</syntaxhighlight>

In order:
* <code>birth_control_pills</code>: the item identifier.
* <code>id</code>: a numeric id. Unused at this moment.
* <code>name</code>: the item's name, as seen in the backpack.
* <code>cost</code>: the item's cost. Will be cast as an integer, and will prevent the player from picking up the item if he doesn't have sufficient money.
* <code>image</code>: the item's miniature image, as seen in the backpack.
* <code>description</code>: the item's description, as seen in the backpack.
* <code>closeup</code>: the item's close-up image, if there is one.
* <code>dialogue_label</code>: the item's dialogue label, which will trigger if it exists, on clicking the item. The label should absolutely return, and take an item argument.
* <code>popup_image</code>: the item's pop-up image. Displayed when first acquiring the item, leave the string empty if there is none.

=== Text messages ===

'''Text messages''' are stored in this format in <code>text_messages.json</code> file. Once defined there, you can use <code>player.receive_message(message_id)</code> for the player to receive the message.

<u>'''Example:'''</u>

<syntaxhighlight lang="json">
"mia02": {
    "sender": "mia",
    "content_preview": "We can't find {b}my dad{/b}...",
    "content": "We can't find {b}my dad{/b}...\nCan you come help us please?",
    "image": "cellphone/cellphone_text_mia01.png"
}
</syntaxhighlight>

In order:
* <code>mia02</code>: the message identifier. Must be unique. Message identifiers ending in "_pregnancy" or "_pregnancy_labor" are reserved for the pregnancy system's messages.
* <code>sender</code>: the name of the machine that sent this message.
* <code>content_preview</code>: the short text you see on the main messages screen on the cellphone.
* <code>content</code>: the actual message you see when clicking the message in the phone.
* <code>image</code>: the image used as a "profile picture" on the cellphone.

=== Achievements ===

'''Achievements''' are defined in <code>achievements.json</code> file.

<u>'''Example:'''</u>

<syntaxhighlight lang="json">
"angler": {
    "id": 1,
    "name": "The Angler",
    "description": "Catch one of every type of fish.",
    "hidden": false,
    "enabled": true,
    "image": "achievements/cellphone_achieve_01.png"
}
</syntaxhighlight>

In order:
* <code>angler</code>: the achievement identifier. Must be unique. The identifier is used to name the achievement variable. Dashes are replaced with underscores. All achievements are prefixed with "A_".
* <code>id</code>: a numeric id. Unused.
* <code>name</code>: the achievement's name.
* <code>description</code>: the achievement's description. New lines are inserted every 30 characters, words are not split in the middle.
* <code>hidden</code>: whether it's a secret achievement or not.
* <code>enabled</code>: if the achievement can be achieved.
* <code>image</code>: the icon for this achievement.

=== Dialogues ===

The <code>dialogues.json</code> file is used for the dialogue lines written by patrons.

=== Keybindings ===

{{AlertWarn|This is not currently implemented in the game}}

This file lists the default key-bindings used by the minigames.

=== Furnishings ===

{{AlertWarn|This is not currently implemented in the game}}

This file will be similar to <code>items.json</code>. At the moment, no furnishings have been implemented. Those will be furnishings to be put in the [[Beach House|beach house]] with an upgrade system.

== Game manager class ==

The '''game manager class''' handles everything that is related to the gameplay itself, but is not planned to be extendable by mods. Its methods and attributes are still useable and should be used for your mod.

; language : A class-level attribute that sets the language of the game, which is used for translations. It defaults to "en" for english with other languages in the game untranslated (like Spanish or French for instance).
; cheat_mode : An attribute that is True if the game is currently in cheat mode (allowing minigames to be skipped).
; CA_FILE : Path to a certification file used to enable requests to websites. Is unused unless the player uses the "allow internet connection" checkbox in the options.
; lock_ui(), unlock_ui() and ui_locked() : Locks, unlocks and returns whether the user interface is locked or not (i.e. grayed out).
; dialog_select(string label_name) : Classmethod that will choose a label based on its name and the language class attribute. To be used to split dialogues, and logic, and also allows your mod to be easily translated.
; choose_label(string template) : Classmethod that chooses a label at random that matches the template passed in the arguments.
; main() : Method that is to be called at the end of every label the player jumps to (and not '''called''' to). It calls the player's location screen, and checks for achievements and other stuff. This would be the only method expandable upon. It also clears the return stack, so that traceback are not undigestible. It may take two arguments, <code>clear_return_stack</code> to enable or not return stack clearing, and location, to call the screen of another location than the player's currently in.
; is_christmas() and is_halloween() : Classmethods that will check whether the system clock matches christmas or halloween.

== Player class ==

The '''player class''' handles everything related to the player, its inventory, grades, vehicle level and stats. Notable methods:

; receive_message(string message_id) : Check if the player has received the given message on the cellphone. Also sets up the alert icon on the UI.
; has_item(string* items) : Check if the player has any of the items provided at this moment.
; has_picked_up_item(string* items) : Check if the player has ever picked up any of the items provided.
; get_item(string item), remove_item(string item) : Get the item, if the item's cost is no higher than the amount of money the player has. Conversely, removes an item by its string id.
; get_money(int money) and spend_money(int money) : Add and substract money from the player.
; has_required_str(int min_str) : Check if the player has the required str (similar for chr, int and dex)
; go_to(Location location) : Go to the given location.
; go_to_previous() : Go to the first parent location of the player's current location.
; increase_str(int amount) : Increase the strength by amount. Defaults to 1. Similar methods exist for int, chr and dex.

== Miscellaneous functions and classes ==

; KeepRefs : A class used everywhere to make sure to keep a reference to any object instantiated, making sure '''is''' checks are kept correct.
:; get_instances() : Classmethod to get a generator of all the instances of this class' subclass.

; LastUpdatedOrderedDict : A dictionary-like structure that keeps its order, and store its items in the order the keys were last added (and not ''updated''). This is a subclass of Python's OrderedDict from the collections package.
:; listvalues : Return a list of all the values of this dictionary.
:; listkeys : Return a list of all the keys of this dictionary.
:; lastkey : Return the last key added to this dictionary.
:; lastvalue : Return the value of the last key added to this dictionary.
:; isempty : Return whether the dictionary is empty.

; format_seconds_to_dhm(int seconds) : Return a formatted string in the form (x)d (y)h (z)m from the number of seconds passed in the arguments.

; insert_newlines(string string_to_format, int every) : Return a new string based on the passed in string, with newlines inserted every ''every'' character. ''every'' defaults to 30. Differs from splice_string() in that it will not cut a word in the middle if possible. <code>splice_string()</code> will insert a newline every ''every'' characters without question. <code>insert_newline()</code> is much safer as it will not cut a variable substitution, but is much slower than splice_string.

; text_identity(string text) : Return unmodified text, useful for <code>config.say_menu_text_filter</code> if it is None.

; replace_bracket(string text) : Return text without the [ and ] characters (Ren'Py variable formatting syntax).

; gauss(float mean, float deviation, float lower, float upper) : Return a random integer number in a normal distribution, clamped between lower and upper.

; get_angle_speeds(int angle_width, Iterator angle_range, Iterator speed_range) : Return two lists, <code>true angles</code> and <code>false angles</code> which are lists of tuples (initial_angle, initial_speed) for which the result land in or out of the <code>angle_width</code>. Used in the [[Pregnancy Minigame|pregnancy minigame]] and [[Spin The Bottle Minigame|Spin the Bottle minigame]].

;safe_parse_dict(dict dct, object* keys, object default=None, list list_to_append=None) : Return the content of the dictionary at keys keys, subscripted in order. If a KeyError exception is raised, and a default is provided, then will return that default object. Any number of keys can be passed up to 253 (hard limit in CPython). Additionally, you can pass in a list to append the name of the missing keys of the dictionary to.

<u>'''Examples:'''</u>

<syntaxhighlight lang="Python">
safe_parse_dict({"a":{"b":2}}, "a", "c", default="default return value")
# returns "default return value"
safe_parse_dict({"a":{"b":2}}, "a", "b", default="default return value")
# returns 2
safe_parse_dict({"a":{"b":2}}, "a", "b", "default return value")
# prints "Extra positionnal argument passed, is default properly named in the arguments?" and returns 2
safe_parse_dict({"a":{"b":2}}, "a", "c", list_to_append=missing_keys)
# appends "c" to list missing keys and returns None. If a default argument is passed, will return default
</syntaxhighlight>

= Hooking into the game =

{{AlertWarn|This feature of the modding API is incomplete as of version 0.18.0, the ModManager class is present, but no hooking of any kind can be done at the moment. This message will be deleted once everything is in place}}

== Registration and Enabling of the mod ==

In an init -9 python or later, use the class method "register" of the ModManager class to register your mod to the game.
This registration will make the mod show up in the (upcoming) Mods menu on the main menu of the game. From then, the player may or may not enable the mod for his game.

<syntaxhighlight lang="Python">
init python:
    ModManager.register("ikarumod")
</syntaxhighlight>

It is necessary to create a manifest file named "modname_manifest.json" in the scripts/data folder.

== Manifest file ==

The manifest file will tell the game in which labels your mod should hook into, and which screens. It will also define the name of the main function you wish to use to hook into the game.main() function, if any.

=== Preferred mod load order ===

Adding a key named load_order to the manifest will allow your mod to be loaded after a specific amount of mods, or before.
The value of this key must be a string leading with either ">", "<" or "=" followed by an integer. Additionnally, the values "inf" and "-inf" can be used to set the load order as last, and absolutely first. If several mods are found with the "-inf" load_order, a random order is chosen. This defaults at "inf", which means the mods will be added last to the list in no particular order.

=== Main function name ===

This key should be a string containing the name of the main function of your mod. The function will be searched for ini the globals() of the game (global namespace)

=== Init label name ===

This key should give the name of a label your mod uses at init time, which means after the game fully initializes, either at the start of the game or after the load of the game.

This label is called in a new context, and it must return, otherwise other mods won't be loaded

=== Adding to the game's json files ===

Keys in the manifest named <code>items</code>, <code>achievements</code> and <code>text_messages</code> can be used to add data to the game's json files.
Each of these keys expects a full json dictionary, formatted just like their respective models.

=== Example of a manifest ===

<syntaxhighlight lang="json">
{
    "name":"ikarumod",
    "version": "0.1.0",
    "load_order": ">3",
    "main_function_name": "ikarumod_main",
    "init_label_name":"ikarumod_init_label",
    "text_filter":"ikarumod_text_filter",
    "items": {
        "item1":{
            ...
        },
        "item2":{
            ...
        }
    },
    "text_messages":{
        "text_message1":{
            ...
        }
    },
    "screen_hooks":{
        "upstairs_bedroom":"upstairs_bedroom_ikarumod",
        "bedroom":"bedroom_ikarumod"
    },
    "label_hooks":{
        "bedroom":"bedroom_ikarumod"
    },
    "achievements":{
        "angler-2"{
            ...
        }
    }
}
</syntaxhighlight>

== Mod init order ==

{{AlertInfo|Mods are assumed to be in an initial random order}}

For every mod that is enabled, create a Mod instance with that mod's name, parse the load order from the manifest, then insert that mod in the <code>ModManager.mods list</code>, in the proper position.

Then, for every mod in the <code>ModManager.mods</code> list, call their init label, if defined.

Finally, update the game's stores (ie achievements, items and text_messages) with every mod's data. Updates overwrite the keys, so the load order can be used to overwrite the game's (although ill-advised) or another mod's items/text_messages/achievements.

== Text Filter ==

This key in the manifest will allow you to implement your own text filter function, without overwriting other mods.
If undefined, this will default to <code>lambda text:text</code>, otherwise the value of this key should be a string of the name of the function you wish to pass in as a text filter. If the function cannot be found in the global namespace (i.e. the globals() dictionary), then a <code>ModLoaderError("No Function named {text_filter} found in the global namespace. Is it defined properly?")</code> exception will be raised.

== Screens ==

{{AlertInfo|Not implemented at this time}}

Create your screens with the following convention : modname + _ + in-game screen name (the Ren'Py definition name).
Screens are being included into the main game screens with the use statement. If you wish to add new locations, you'll have to define a screen for it, in which case, you can inspire yourself with the existing screens in the game.

To add the proper background, start with the statement <code>add player.location.background</code>, which will automatically show the proper background according to the time of day/period of the year. You can then add imagebuttons as you see fit. Please refer to the [[#User-defined screen actions|user-defined screen actions]] for more information on which screen actions the game defines.

== Labels ==

{{AlertInfo|Not implemented at this time}}

Only "main" labels can be hooked into. Those are labels that end in <code>$ game.main()</code>.

== Main function ==

{{AlertInfo|Not implemented at this time}}

To hook into the main function, you must register your main function to the ModManager.

<syntaxhighlight lang="Python">
init python:
    ModManager.register_main(ikarumod_main)
</syntaxhighlight>

In the above example, <code>ikarumod_main</code> is assumed to be a callable, which should be a python function. This function will be called with no arguments at the end of <code>game.main()</code> method.

Hooking into the main function is usually useful for code you want executed every time the game returns to a main screen, i.e. at the end of location labels for instance. This is where you can repeatedly check if the condition for an achievement has been fulfilled. If the provided function is not a callable, a ModLoaderError exception will be raised.

= Imported modules and directory structure =

== Third-party modules ==

=== Platform agnostic ===

: os
: pygame
: sys
: from time : time, clock
: from copy : copy, deepcopy
: datetime
: re
: random
: math
: from collections : defaultdict, OrderedDict and Counter
: weakref
: codecs
: hashlib
: json
: itertools
: operator
: textwrap
: deuces

=== Desktop builds ===

: certifi
: requests

=== Mobile builds ===

: android
: pyjnius

== Directory Structure ==

* <code>game</code>
** <code>audio</code>: SFX and musics
** <code>fonts</code>: Fonts for the game.
** <code>images</code>
*** <code>achievements</code>: Achievement-related images.
*** <code>cookie_jar</code>: Cookie jar buttons, popups and thumbnails.
*** <code>backgrounds</code>: Backgrounds and close-ups.
*** <code>boxes</code>: Popups and general purpose buttons (like the go back button).
*** <code>buttons</code>: Most minigame assets, and menu buttons.
*** <code>cellphone</code>: Cellphone images assets.
*** <code>characters</code>: Character poses. One folder per character.
*** <code>map</code>: Map locations and map background.
*** <code>objects</code>: Character buttons, item buttons, doors, etc.
*** <code>vfx</code>: Special visual effects (like the rain in roxxy's trailing scene).
** <code>python-packages</code>: Third party python modules.
** <code>scripts</code>
*** <code>characters</code>: One folder for each character, containing an fsm file, a character.rpy file for miscellaneous stuff, and a layeredimage definition file. May contain a file for the character's button and the according dialogues.
*** <code>core</code>: Core files are put there, mostly what has been documented in the Modding API section of this manifesto.
*** <code>data</code>: JSON files that contain data about the game. Items, achievements, keymap or text messages are defined here.
*** <code>defines</code>: General image definitions, transforms, etc.
*** <code>locations</code>: One folder for every location, sorted in a tree-like structure. Each location has a main file, a screen file and a dialogues file.
*** <code>minigames</code>: One folder for every minigame, the minigame dialogues and screen files are in that folder.
*** <code>script.rpy</code>
*** <code>pregnancy_announcements.rpy</code>
** <code>changelog.txt</code>
** <code>pledge_list.txt</code>

= Translating the game =

== Label calling in the game ==

The game has a function in the Game class to select different dialogues based on the language class attribute defined there. To change that attribute, it's just a matter of writing this piece of code in a separate ".rpy" file.

<syntaxhighlight lang="Python">
init 1 python:
    Game.language = "es" # for Spanish for instance, "fr" for French, etc
</syntaxhighlight>

Every time a dialogue is called, the game looks for the label name and the language string at the end. For instance, the label <code>bank_liu_account_info</code> has the english version in, to overwrite that dialogue, you'd have <code>bank_liu_account_info_fr</code> or <code>bank_liu_account_info_es</code> depending on the value of the language string.

This method can be used to translate any dialogue in the game. Keeping a consistent directory structure is recommended, because of the large number of dialogues in the game. You'll also have to copy over the posing. For your convenience, every dialogue label is in a <code>dialogues.rpy</code> file for that location. Just copy the file and edit the dialogue and the label name.

== Cutscenes and minigame instructions ==

For these cases, you can't edit the cutscene directly. Well, to be honest, you could, but you shouldn't. The best way is to use the <code>config.say_menu_text_filter</code> variable. Just register a function to that variable that should take one argument: <code>text</code>, which will contain the text of the displayable. You can then edit the text how you see fit.

<u>'''Example of translation:'''</u>

<syntaxhighlight lang="Python">
init 10 python:
    fr_translations = {"Using the key and stool, I was able to get into our attic.\nI had never been up there before.\nI was filled with excitement wondering what treasures {b}[deb_name]{/b} and dad had stashed away.": "En utilisant la clé et le tabouret, je pus aller dans le grenier.\nJe n'y avais jamais été auparavant.\nUn sentiment d'excitation m'envahissait alors que je me demandais quels trésors {b}[deb_name]{/b} et papa avaient caché là-haut."}

    def fr_text_filter(text):
        if text in fr_translations.keys():
            return fr_translations[text]
        else:
            return text
    
    config.say_menu_text_filter = fr_text_filter
</syntaxhighlight>

Keep in mind however that Ren'Py engine won't handle large dictionaries. You can use <code>elif</code> statements and split the content into several dictionaries if necessary.

<u>'''Example:'''</u>

<syntaxhighlight lang="Python">
def fr_text_filter(text):
    if text in fr_translations_1.keys():
        return fr_translations_1[text]
    elif text in fr_translations_2.keys():
        return fr_translations_2[text]
    else:
        return text
</syntaxhighlight>

In the future, registering to <code>config.say_menu_text_filter</code> variable will be done with the <code>+=</code> assignment, to allow several mods to subscribe to it. Mod load order will apply.

== For location names ==

In an <code>init 1 python</code> (or later) block, you can set the display name of any location object in the game.

<u>'''Example:'''</u>

<syntaxhighlight lang="Python">
init -1 python:
    L_map.display_name = "New Map Name"
</syntaxhighlight>

This will allow you to rename or translate any location in the game, thus displaying that name in relevant parts of the user interface.