Modding Documentation for Sexting my GF

Hey there, future mod creator! 💕 Welcome to the complete modding guide for Sexting my GF! This documentation has everything you need to bring your stories to life.

Installing Mods

Want to try out some mods before creating your own? Open the Mods app on the phone and choose your method:

🌐 Method 1: Download from URL (Recommended)

1. Get a .zip file URL from Discord or other sources
2. Click the green Install button in the Mods app
3. Paste the URL and click "Download Mod"
4. Once downloaded, click "Load" and you're ready!

👆 Visual guide showing the installation process

Note: URLs must point to .zip files. The game includes security protection against malicious files.

Okay okay, enough playing around! Time to start working on your own spicy stories! ✨

Requirements

Before you start modding, you'll need:

• Basic text editing - VS Code or Cursor recommended for the best experience (And get the Ink extension for VS Code)
• Ink language knowledge - Learn from the resources below
• Image editing software - For creating character images and scenes
• Twin Problems example mod - Comes with the game and is highly recommended to study!

Quick Setup

Follow these steps to create your first mod:

Folder Structure

Every mod must follow this exact folder structure. You'll need to create these folders manually (or copy the Twin Problems folder and rename it to your mod name):

Your Mod Name/
├── mod.json                    // Mod configuration
├── Characters/                 // Character definitions
│   ├── character1.json
│   └── character2.json
├── Conversations/              // Story conversations
│   ├── My Cool Story/          // Name folders whatever you want!
│   │   ├── story1-1.ink
│   │   ├── story1-1-settings.json
│   │   └── Side Stories/       // Optional side stories
│   │       ├── sidestory1.ink
│   │       └── sidestory1-settings.json
│   └── The Ending/             // Full creative freedom!
└── Images/                     // All images for your mod
    ├── character1.png
    ├── scene1.png
    └── header.png              // Mod banner image

Mod Configuration

The mod.json file contains essential information about your mod:

{
    "modId": "your-unique-mod-id",
    "modName": "Your Mod Display Name", 
    "version": "1.0.0",
    "author": "Your Name",
    "description": "A brief description of your mod story",
    "headerImage": "header.png"
}

Characters

Characters are defined in JSON files within the Characters folder. Each character needs their own file:

{
    "isMainCharacter": false,
    "contactID": "character_id",
    "contactName": "Character Name",
    "contactNickname": "Nickname", 
    "contactNicknameShort": "Nick",
    "profilePicturePath": "character.png"
}

Conversations

Conversations are the heart of your mod. They're written in the Ink language and control the story flow. The Twin Problems mod that comes with the game is your best teacher here - seriously, check it out!

Basic conversation structure

EXTERNAL GetStoryFlag(flagName)
EXTERNAL SetStoryFlag(flagName)  
EXTERNAL RemoveStoryFlag(flagName)

-> start

== start
Hey there! How's your day going?

* Good, thanks for asking!
    -> good_response
* Pretty terrible honestly
    -> bad_response

== good_response
That's great to hear!
-> END

== bad_response  
Oh no, what happened?
-> END

Ink Language Basics

Here are the essential Ink concepts you need to know:

== my_story_section
This is a knot!

* Choice 1
* Choice 2

-> next_section

-> END

Choice System

The game supports several special choice types:

🔴 Important Choices

Add an exclamation mark to highlight those *really* important decisions (you know the ones 😉):

* !This is a very important choice
    -> important_consequence

Shows a red exclamation mark next to the choice in-game.

👤 Action Choices

Choices that don't appear as messages (wrapped in %):

* %Don't send the photo%
    -> no_photo_sent

Perfect for internal actions or decisions.

💬 Suppressed Choices

When the choice text differs from what's actually sent (minimum 4 characters between <>):

* <Surely> Yes I know for sure
    -> confident_response

Player sees "Surely" but sends "Yes I know for sure".

💖 Route Choices

Add route indicators to important choices to show players what type of content they're choosing. This only works with important choices (those with exclamation marks !):

* !(love) This choice is for the love route
    -> romantic_path
* !(ntr) This choice is netorare focused  
    -> ntr_path
* !(ntrs) This choice is netorase focused
    -> ntrs_path

Route indicators:

• (love) - Love route focused - shows 💘 heart emoji
• (ntr) - Netorare focused - shows 😈 smiling purple devil emoji
• (ntrs) - Netorase focused - shows 😘 kissing emoji

You can also combine routes:

* !(ntrs,love) This choice is both NTRS and Love focused
    -> combined_path

Route choices work with suppressed choices too!

* !(ntrs, love) <HELP ME> Heyy, just chilling at uni. You okay?
    -> logan_greeting
* !(ntr) What do you want now, Logan?
    -> logan_greeting

👆 Visual example showing how route choices appear in-game

Note: Route choices help players understand what type of content they're selecting, making navigation through different story paths clearer. They work perfectly with suppressed choices too!

Functions

Functions are special commands you can use anywhere in your conversations to make the game do things that ink doesn't support natively.

Available functions

EXTERNAL GetStoryFlag(flagName)
EXTERNAL SetStoryFlag(flagName)
EXTERNAL RemoveStoryFlag(flagName)

EXTERNAL ShowCustomTransition(title, subtitle)

EXTERNAL GetStoryFlag(flagName)
EXTERNAL SetStoryFlag(flagName)
EXTERNAL ShowCustomTransition(title, subtitle)

-> start

== start
{
    - GetStoryFlag("sarah_angry"):
        She's still mad at you...
        -> angry_path
    - else:
        We talked it out and...
        -> transition_to_makeup
}

== transition_to_makeup
~ ShowCustomTransition("Chapter 2", "Making up")
Hey there! 😊
~ SetStoryFlag("made_up_with_sarah")
-> END

Flags & State Management

Flags let you track player choices and create branching storylines:

~ SetStoryFlag("player_chose_honesty")

{
    - GetStoryFlag("player_chose_honesty"):
        I remember you value honesty
        -> honest_path
    - else:
        -> default_path
}

{
    - GetStoryFlag("sarah_angry"):
        She's still mad at you
        -> angry_sarah
    - GetStoryFlag("sarah_happy"):
        She seems in a good mood
        -> happy_sarah
    - else:
        She seems neutral
        -> neutral_sarah
}

~ RemoveStoryFlag("temporary_flag")

Special Messages

The game provides custom commands to enhance your storytelling:

<wait-3>

<image-filename>

<wait-3>
<sarah-at-beach>

<player-image-filename>

<player-sunset-photo>

<fake-type-4>

<side-story-ben_interruption>

~ ShowCustomTransition("Chapter 2", "The Plot Thickens")

Images

Images are automatically imported based on their filenames in the Images folder.

Conversation Settings

Every .ink file needs a corresponding -settings.json file to control timing and flow:

{
    "storyId": "sarah-chat-1",
    "contactID": "sarah",
    "nextStoryId": "sarah-chat-2",
    "isStartingStory": true,
    "forceTimeInHours": 14,
    "passTimeInMinutes": 30,
    "timeIsExact": false,
    "forceDay": 0,
    "isSideStory": false
}

Side Stories

Side stories are conversations that interrupt the main flow and then return to where they left off:

Creating a side story

{
    "storyId": "ben-interruption",
    "contactID": "ben", 
    "isSideStory": true
}

<side-story-ben-interruption>

Time Management

Control when conversations happen to create realistic pacing:

{
    "forceTimeInHours": 8,
    "passTimeInMinutes": 30,
    "timeIsExact": true
}

{
    "forceTimeInHours": 14,
    "passTimeInMinutes": 15,
    "timeIsExact": true
}

{
    "forceDay": 5,
    "forceTimeInHours": 19,
    "passTimeInMinutes": 0,
    "timeIsExact": true
}

Testing & Validation

Ensure your mod works perfectly before sharing:

Complete Example

Here's a complete simple mod to demonstrate all concepts:

{
    "modId": "first-date", 
    "modName": "First Date",
    "version": "1.0.0",
    "author": "Your Name",
    "description": "A sweet story about a first date",
    "headerImage": "header.png"
}

{
    "isMainCharacter": false,
    "contactID": "emma",
    "contactName": "Emma",
    "contactNickname": "Emma", 
    "contactNicknameShort": "Emma",
    "profilePicturePath": "emma.png"
}

EXTERNAL GetStoryFlag(flagName)
EXTERNAL SetStoryFlag(flagName)
EXTERNAL RemoveStoryFlag(flagName)

-> start

== start
Hey! I had such a great time on our date yesterday 😊

* It was amazing! I'd love to see you again
    ~ SetStoryFlag("wants_second_date")
    -> positive_response
* It was nice, but I think we should just be friends
    ~ SetStoryFlag("just_friends")
    -> friend_zone

== positive_response
Really? I was hoping you'd say that!
<wait-2>
Would you like to go out again this weekend?

* !Absolutely! I'd love to
    Perfect! I'll plan something special
    -> END

== friend_zone
Oh... okay, I understand.
<wait-3>
Friends it is then! 

* Thanks for understanding
    Of course. Take care!
    -> END

{
    "storyId": "first-conversation",
    "contactID": "emma",
    "nextStoryId": null,
    "isStartingStory": true,
    "forceTimeInHours": 10,
    "passTimeInMinutes": 0,
    "timeIsExact": true,
    "forceDay": 6,
    "isSideStory": false
}