diff --git a/Docs/FAQ.txt b/Docs/FAQ.txt new file mode 100644 index 0000000..e0d6bf3 --- /dev/null +++ b/Docs/FAQ.txt @@ -0,0 +1,59 @@ +1. Dev questions + 1.1. Why don't we have feature X yet? + 1.2. Are you going to add feature X? +2. Gameplay questions + 2.1. What do I do? Where do I go? + 2.2. I don't have a place to live! + 2.3. How do I find a residential building, bar, hotel, etc.? + 2.4. How do I change a building's type? +3. Tech questions + 3.1. I can't bring up the console! + 3.2. How do I change or add to the content? + +1. Dev questions + +1.1. Why don't we have X yet? + +Because it hasn't been made yet. Perhaps you can help out? +Creating content for LifePlay is easy to do, and because it's meant to be a moddable game, it's not just the developer who can do it. See the Docs/Modding folder to learn how. + +1.2. Are you going to add X? + +Quite possibly. It may take a while though. Other things need adding too! + +2. Gameplay questions + +2.1. What do I do? Where do I go? + +The idea is that you live the life of the character you're playing. There is no one story, and no other background to the player character than what you imagine yourself. You can tweak your character's looks and stats, potentially give them relatives via the contacts menu (ctrl-P), make sure to load up content modules that fit your tastes (ctrl-M), and take it from there. + +You should probably find a place to live, and get an income so you can pay for expenses. Or you could just sleep in hotels and hope money'll drop from the sky. Suit yourself ;) + +2.2. I don't have a place to live! + +Find a residential building during work hours, click on it, and select "arrange a viewing". This'll then give you the option to rent an apartment, or not. + +2.3. How do I find a residential building, bar, hotel, etc.? + +Hover the mouse over a building and ideally, an icon should show up telling you what type of building it is. Buildings with a question mark haven't been given a type yet. +You can also click on the magnifying glass icon to the left, leave the search field blank, then click on the icon so you can choose from a variety of building types to choose from. The search results will try to display them based on how far you have to walk. + +2.4. How do I change a building's name or type? + +Some maps have far more detailed information on buildings than others, and it's also always possible you want to insert or change a building type because you just want to. To do that, you just click on any building, and select "edit building". + +Changes to a building on a map carry over to any new game you start on that same map, so perhaps you shouldn't change buildings on one game that could be your other game's character's home or job? + +3. Tech Questions + +3.1. I can't bring up the console! + +Ordinarily you bring up the console with # +Due to different keyboard mappings throughout the world, though, the key to use may differ for you. You can change the key in Config/DefaultInput.ini, look for the line: + +ActionMappings=(ActionName="TestScenes",Key=#,bShift=False,bCtrl=False,bAlt=False,bCmd=False) + +3.2. How do I change or add to the content? + +Intel on how to write or edit scenes is found in the Docs/Modding folder. It mostly deals with the scripting language at the moment, in a noob-friendly way, and focuses on adding scenes, actions, stats, character presets, sex descriptions and sex talk. These are the easiest to change: a simple text editor is all you need, and the documentation is noob-friendly. + +(Not ready to say anything useful about asset creation...) \ No newline at end of file diff --git a/Docs/Modding/Command_Functions/Divorce.txt b/Docs/Modding/Command_Functions/Divorce.txt new file mode 100644 index 0000000..9dc73ae --- /dev/null +++ b/Docs/Modding/Command_Functions/Divorce.txt @@ -0,0 +1,15 @@ +Divorce() + +USE: +This command undoes the marriage between player and their husband/wife. It will revert their status to being boyfriend(s)/girlfriend(s) though, so you probably want to follow up with loseDating(). + +TYPE: Command, non-Ref +RETURNS: / +THEME: Relationships +COMPARE: getMarried, isMarried, loseDating + +EXAMPLE: + Official:: "Sign here and here and here and here... Initial here and here and here... Very well, everything's in order." + Player(Disgusted):: "About damn time!" + Divorce() + loseDating() \ No newline at end of file diff --git a/Docs/Modding/Command_Functions/Filter.txt b/Docs/Modding/Command_Functions/Filter.txt new file mode 100644 index 0000000..0aebcdd --- /dev/null +++ b/Docs/Modding/Command_Functions/Filter.txt @@ -0,0 +1,21 @@ +Filter(Tag) + +USE: +Limit a sex scene to animations that have the specified tag. + +TYPE: Command, non-Ref +RETURNS: / +THEME: Sex +COMPARE: TalkNonConsensual + +EXAMPLE: + + "A while later in front of her place." + Player(Flirty)::"Baby, since I just took you to that fancy place and all, maybe I could... come inside?" + Girlfriend(Offended)::"Hey, what do you take me for? I don't put out just for a meal!" + Player(Shy)::"I know you don't, I mean, I didn't think you would, but... please, being around you drives me nuts! I'm about to burst!" + Girlfriend(Annoyed)::"Oh, alright then. But there's no way we're actually doing 'it' tonight! A quick shake and then I'm off to bed, and you're off to yours!" + setBackground(home) + Player.strip() + Filter(Handjob) + Sex(Player, Girlfriend) \ No newline at end of file diff --git a/Docs/Modding/Functions/LosePT.txt b/Docs/Modding/Command_Functions/LosePT.txt similarity index 72% rename from Docs/Modding/Functions/LosePT.txt rename to Docs/Modding/Command_Functions/LosePT.txt index cd87a32..80d1262 100644 --- a/Docs/Modding/Functions/LosePT.txt +++ b/Docs/Modding/Command_Functions/LosePT.txt @@ -1,7 +1,13 @@ losePT() +USE: The player fires their current personal trainer. +TYPE: Command, Non-Ref +RETURNS: / +THEME: Special Characters +COMPARE: setPT + EXAMPLE: Player(Angry):: "I've made no progress under your instructions. You're fired!" losePT() diff --git a/Docs/Modding/Command_Functions/Random.txt b/Docs/Modding/Command_Functions/Random.txt new file mode 100644 index 0000000..c4b482b --- /dev/null +++ b/Docs/Modding/Command_Functions/Random.txt @@ -0,0 +1,17 @@ +Random(float, float) + +USE: +returns a random float number between the entered float parameters. Commonly used to influence the chance a condition is true based on an actor stat. + +TYPE: Command, non-Ref +RETURNS: float +THEME: Math +COMPARE: + +EXAMPLE: + attrBonus = Random(1,5) + Actor:attrtoplayer += attrBonus + + If Random(30, 100) > attractiveness // condition is only possible if attractiveness is higher than 30, and more likely to happen the higher attractiveness is + + If Random(50,300) < Actor:perversion // only possible perversions is higher than 50, but only has a 20% chance of happening \ No newline at end of file diff --git a/Docs/Modding/Command_Functions/Sex.txt b/Docs/Modding/Command_Functions/Sex.txt new file mode 100644 index 0000000..5c0925d --- /dev/null +++ b/Docs/Modding/Command_Functions/Sex.txt @@ -0,0 +1,20 @@ +Sex(Actor1, Actor2, ..., ActorN) + + +USE: +Start a sex scene involving these actors. If the player is involved, it will also check whether the player is cheating or not and add to the affair list accordingly. +The order in which roles are given to actors for the sex scene (important for descriptions and dirtytalk) depends largely on gender and domincance. Males are given roles before transsexuals, then women. Between people of the same gender, the most dominant one (lowest submission stat) is given a role first. +However, the order of the actor parameters to the Sex() function matters somewhat in group sex: Sex(Male1, Player, Male2) will be different from Sex(Male2, Player, Male1). + +TYPE: Command, non-Ref +RETURNS: / +THEME: Sex +COMPARE: SexNoAffair + +EXAMPLE: + Boss(Happy):: "Baby, let's get closer!" + Sex(Boss, Player) + + If Boss.isAffair() // if you are in a relationship with someone else, this will return true after sex + "I cheated on my boyfriend with my boss." + Endif \ No newline at end of file diff --git a/Docs/Modding/Command_Functions/SexNoAffair.txt b/Docs/Modding/Command_Functions/SexNoAffair.txt new file mode 100644 index 0000000..824e354 --- /dev/null +++ b/Docs/Modding/Command_Functions/SexNoAffair.txt @@ -0,0 +1,19 @@ +SexNoAffair(Actor1, Actor2, ..., ActorN) + +USE: +Start a sex scene involving these actors. Even if the player is involved, it will not check whether the player is cheating or not. +The order in which roles are given to actors for the sex scene (important for descriptions and dirtytalk) depends largely on gender and domincance. Males are given roles before transsexuals, then women. Between people of the same gender, the most dominant one (lowest submission stat) is given a role first. +However, the order of the actor parameters to the Sex() function matters somewhat in group sex: SexNoAffair(Male1, Player, Male2) will be different from SexNoAffair(Male2, Player, Male1). + +TYPE: Command, non-Ref +RETURNS: / +THEME: Sex +COMPARE: Sex + +EXAMPLE: + Boss(Happy):: "Baby, let's get closer!" + SexNoAffair(Boss, Player) + + If Boss.isAffair() // this will return false no matter what + "I cheated on my boyfriend with my boss." + Endif \ No newline at end of file diff --git a/Docs/Modding/Command_Functions/TalkNonConsensual.txt b/Docs/Modding/Command_Functions/TalkNonConsensual.txt new file mode 100644 index 0000000..52e615b --- /dev/null +++ b/Docs/Modding/Command_Functions/TalkNonConsensual.txt @@ -0,0 +1,15 @@ +TalkNonConsensual() + +USE: +call this command before starting a sex scene to make sure that none of the regular 'dirtytalk' (ie both ppl wanting it) is played, and only non-consensual talk is played. + +TYPE: Command, non-Ref +RETURNS: / +THEME: Sex +COMPARE: Filter(Aggressive) + +EXAMPLE: + "Before I knew what was happening, the door slammed shut behind me..." + Filter(Aggressive) + TalkNonConsensual() + SexNoAffair(Aggressor, Player) \ No newline at end of file diff --git a/Docs/Modding/Command_Functions/WHAT.txt b/Docs/Modding/Command_Functions/WHAT.txt new file mode 100644 index 0000000..1b1e6a0 --- /dev/null +++ b/Docs/Modding/Command_Functions/WHAT.txt @@ -0,0 +1,20 @@ +WHAT + +USE: +WHAT is mostly used to enter a condition at the top of a scene, affecting its random triggering depending on what the player's doing. +However, it can also be used as a command in the rest of the scene script, returning the player's current activity. +Available actionIDs can be found in the different files contained in the "Actions" folder in modules. + +TYPE: Condition, non-Ref +RETURNS: actionID (string) +THEME: Scenes, Activity +COMPARE: WHAT, WHEN + +EXAMPLE: + If WHAT == socialize && WHERE == nightclub + "It shouldn't be surprising that when you talk to random strangers at a nightclub, somebody will think you're just hitting on people." + Jealous = generatePerson() + Jealous.dress() + Jealous.show() + Jealous(Angry)::"Stay away from my , you !" + Endif \ No newline at end of file diff --git a/Docs/Modding/Command_Functions/WHEN.txt b/Docs/Modding/Command_Functions/WHEN.txt new file mode 100644 index 0000000..3f0b332 --- /dev/null +++ b/Docs/Modding/Command_Functions/WHEN.txt @@ -0,0 +1,19 @@ +WHEN + +USE: +WHEN is mostly used to enter a condition at the top of a scene, affecting its random triggering depending on what time of day it is. +However, it can also be used as a command in the rest of the scene script, to return the time of day in a float. + +TYPE: Command, non-Ref +RETURNS: float +THEME: Scenes, Time +COMPARE: WHAT, WHERE + +EXAMPLE: + If WHEN > 21 || WHEN < 4 + time = "late" + Elseif WHEN < 9 + time = "early" + Endif + "My neighbour's having stereo on, and it's so loud the bass can be heard from a block away! I've got a good mind to tell that I'm calling the police if ever makes such noise this