Guide to Script Writing

This is a tutorial for script writers and idea-guys who want to see their thoughts turned into scenes and requests but have no experience coding.
If you want to get in contact with a coder, either look in the STG thread, or contact Maverick at m8a0v2e8r0i8ck@gmail.com
I've included [tl;dr]'s in each section to make going back easier (you only really need to read through this once).
The sections included in this tutorial are listed below:
	1) Basics - What to Know Before Starting Your Script
		1.a) Actors and Poses
		1.b) Scenes
		1.c) Dialogue
		1.d) Script Comments
	2) More Advanced Writing - Inserts
		2.a) Music and Sound Inserts
		2.b) Picture Inserts
		2.c) Other Inserts
	3) Script Flow - How Do I Make This Readable?
		3.a) The All-Important Tab Key
		3.b) Menus and Choices
		3.c) Whoring Levels
		3.d) Other If Statements
	4) tl;dr Central
	5) Example Script - Taken from Heretic's Mod

1) Basics - What to Know Before Starting Your Script

In order coders to do their job properly, they need special input from writers (think of it like an actual script).
There are scenes, actors, dialogue, poses, and script comments.
Once you  have all of those, you can put them together to write a script.


	1.a) Before you start your scene, you need to have the actors and poses ready:
		What this means is knowing who you want to be in the scene, and having what you want them to look like.
		The way to do this is create faces and poses for Hermione in the Generator, and make sure their filenames fit.
		For Genie, look in your "game" folder for "mage.png".
			This shows Genie's default face, while his others are "mage2.png"-"mage15.png" (We'll get back to this.)
		[tl;dr] - Make the poses you want in the Generator and give them names.

	1.b) So you've got the actors and poses ready! Now we set the scene:
		For this, you just name the scene you're in.
		This should be all the way on the left of your screen, so no tabs.
		You can have a scene named "-Petting" or "-Intro" and for the end "-Wrap up" (exclude the "").
		Scene's make it easy to jump around the script and also to know where you are.
		Think of them as anchors.
		[tl;dr] - Name scenes before diving into dialogue. -Scene Name

	1.c) Now let's move on to dialogue:
		Dialogue will be the majority of your script.
		To start dialogue, we need two things: Actors and Lines.
			Actors are defined before the lines so we know who's talking.
		The two biggest actors we have are Genie and Hermione.
			Genie's default actor name is "m" and Hermione's is "her" (exclude the "").
		Remember the different mage faces we covered earlier? Here's where they become important.
			Unlike Hermione, Genie has a few facial expressions built into the game.
			In order to use something other than the default "mage.png" (tied to the "m" actor) you have to specify it.
			If you want "mage9.png" to be the face used for a certain line of dialogue, start off that line with "g9" instead of "m".
			For "mage11.png" it's g11, and so on.
		For custom actors not in the game, you can specify them by giving their name in quotes before the dialogue.
		So in general, dialogue will look like this:
			m "Suck it."
			her "But I don't want to!"
			g4 "You're gonna make me angry!"
			"Custom Character" "Just do what he says!"
		[tl;dr] - "her" is Hermione, "m" is Genie's default, "g2"-"g15" are Genie's other faces.

	1.d) Script Comments:
		Lets say you want to have your coder understand something that isn't in the text.
			For example you want them to make text bigger or smaller, insert a picture or pose, play an animation, or a sound/music file.
		To include your own comments, write them as "#Comment".
			Be warned, anything in that line after the "#" will be considered a comment.
			In other words, don't start a dialogue option with a comment, put it in the line before or at the end.
				#Comment
				m "Bitch" #Comment
		You can use this to tell your coder things like "#Change her hair color" or "#Make the screen blink".
		[tl;dr] - Want to let your coder know something? Start it with a "#".

	Congrats, you've learned the basics of script writing!
	Using just the tools above, you can begin to write a basic script!
	If you want to learn more about important script flow, skip to section 3.
	If you're ready to learn more advanced parts of script writing, keep reading.

2) More Advanced Writing - Inserts
Now that you have the basics down, you might want to cut down on the time you spend writing comments.
Inserts work much the same way as comments, but with more purpose to them.
Instead of just adding "#Please include x.mp3 sound file here" every time, use inserts.
They save you time, and make coding a lot easier!
Here we'll learn about: music and sounds, pictures, and other inserts.

	2.a) Music and Sound Inserts:
		If you want a specific sound played, you have two options:
			Find one you like in the "game/sounds" folder.
			Get one yourself and include it in the mod.
		Specify what sound or song you want to be played by using the "@".
		If I wanted "game/sounds/clothes.mp3" played, it would look like "@sounds/clothes.mp3".
		For music, the same applies, but you can find them in the "game/music" folder.
		[tl;dr] - Look in the game folder for music and sounds.  Tell me you want them with "@".

	2.b) Picture Inserts:
		Picture inserts work the same as music/sound inserts, but use <> instead.
		Use the name of your face/pose in the <>. If you made a face of Hermione crying, here's what it'd look like:
			m "What? Are you gonna cry?"
			her "N-No..." <crying>
		You can replace <cry> with whatever you'd name your image file for crying.
		This is why it's important to shorten the names of your poses, it's easier to type <c> than <crying>.
		If you're using an image that's already in a folder, then write like you did the sounds/music.
			<my_custom_script/c.png>
		Note: if you're going to be using images not in the "13_hermione_main" folder, it should be:
			<game/name.png>
		[tl;dr] - Use <> to say you want an image shown.

	2.c) Other Inserts:
		We've already covered "@" for sounds and <> for pictures, others work much the same way.
		Non-picture inserts are blocked off by [].
		These are used when you are more comfortable with your coder and they know what you do often.
		Basically, once a coder has seen you ask for something a lot, you can just use [] to shorten it.  Some common ones:
			Menus, random chances, making her come back at night, animations, ending the scene, etc.
		Want to give people a choice, or have a 60% chance of something?
			[Choice] tells to make a menu (we'll get into menu's later on).
			[60%] tells us this'll happen 60% of the time (make sure chances add up to 100).
		Remember the scene's we wrote?  Here's where they come in handy.
			If you want to write several scenes and they have the same ending, use inserts.
			So you wrote a scene called "-Wrap Up", and want to go there? Couldn't be easier.
				[Jump to -Wrap Up]
		As you and your coder get more comfortable (this'll happen very quickly) it'll make the process easier and faster.
		[tl;dr] - Use [] to show you want something done that will require extra coding.

3) Script Flow - How Do I Make This Readable?
You've got the basics down,  now we just need to work on your ability to make things flow well.
This is important because scripts can't look like novels (with paragraphs on end).
They need to be readable in sections and are almost more of a list of events than a full story.
Some things we'll cover are: the importance of tabbing, menus and choices, and if statements.

	3.a) The All-Important Tab Key:
		If you've sneaked a peak at the script below, you'll notice how many tabs there are.
		This is because it gives a sense of flow to the script (and makes it easier for coders).
		It lets readers know what parts rely on other variables.
		So every time you have your script branch into multiple possibilities, you need to tab them.
		The possible variables are laid out in the rest of this section.
		[tl;dr] - Tabbing is real fuckin necessary

	3.b) Menus and Choices:
		Above we mentioned using menus with other inserts.  Here is how to use them.
		When you want the player to make a choice or you want a menu to appear, use either [Menu] or [Choice].
		Then, the next line should be a tab, showing one of the choices, followed by another line with the dialogue in it:
			[Choice]
				Read the guide
					g9 "I've got these scripts down."
				Only read the [tl;dr]'s
					g4 "I thought I could just read these!"
			m "The dialogue continues here."
		If you have a long section after a choice, you can just give them scene names and write [Jump to -Choice name].
			This will save you a lot of tabbing and make the flow look a little nicer, but is not at all necessary.
		[tl;dr] - Use [Choice] or [Menu] if you want branches, and don't forget to tab!

	3.c) Whoring Levels:
		Sometimes you want things to branch depending on other variables.
		One of the most common in Witch Trainer is Hermione's Whoring level.
		If you want her responses to be different to something, just write an if statement:
			m "Take off your skirt"
			#If whoring is less than 15
				her "Fuck you!"
			#If whoring is between 15 and 18
				her "Well... I guess I can do that."
			#If whoring >= 19
				her "I'd love to."
			m "Dialogue continues here"
		[tl;dr] - Whoring makes her change her attitude.  Don't forget tabs damnit!

	3.d) Other If Statements:
		In general, all if statements work the same.
		They branch depending on what if statement is true, then return to the line of dialogue unless told to end.
		Other if statements you can use in the game are:
			How mad she is, what day it is, whether she's done certain quests, even checking what her hair color is.
		The biggest thing to remember is that if statements cause a branch.
		You don't necessarily need 2 branches, but they'll cause something new to happen.
			So you can have a new scene pop up if someone meets certain requirements
			This is great for just adding in a scene to an already existing one.
				"The normal scene"
				#If she has fancy hair and is wearing a mini-skirt
					"What happens"
					[End Scene]
				"The normal scene continues here."
		[tl;dr] - If statements can do a lot.  But don't forget to tab!

4) tl;dr Central
	Actors and Poses - Make the poses you want in the Generator and give them names.
	Scenes - Name scenes before diving into dialogue. "-Scene Name"
	Dialogue - "her" is Hermione, "m" is Genie's default, "g2"-"g15" are Genie's other faces.
	Script Comments - Want to let your coder know something? Start it with a "#".
	Music and Sound Inserts - Look in the game folder for music and sounds.  Tell me you want them with "@".
	Picture Inserts - Use <> to say you want an image shown.
	Other Inserts - Use [] to show you want something done that will require extra coding.
	The All-Important Tab Key - Tabbing is real fuckin necessary
	Menus and Choices - Use [Choice] or [Menu] if you want branches, and don't forget to tab!
	Whoring Levels - Whoring makes her change her attitude.  Don't forget tabs damnit!
	Other If Statements - If statements can do a lot.  But don't forget to tab!

5) Example Script - Taken from Heretic's Mod
	Some things to know:
		This (...) means I've skipped lines, and you're not seeing the full scene.
		This ">text" means the narrator is saying something.
		The faces and pose lists are images Heretic included when he sent me the script.
		The difference between faces and poses are: faces are used for dialogue (bottom right), poses are full body images.

Faces List:
Ahegao = A
Calculating = C
Devious = D
Embarrassed = E
Hesitant = H
Naughty = N
Pensive = Pe
Shocked = S
Questioning = Q

Pose List:
Cumming - p_c
Dildo Deep - p_dd
Dildo Insert - p_di

-Request
m "Miss Granger, do you know what a dildo is?"
her "I... I'm familiar with the concept." <c>
m "Have you used one before?"
her "Excuse me?" <q>
m "There's no need to be embarrassed, girl, just tell me if you've ever used a dildo before."
her "...yes I have." <e>
m "Excellent, well you'll be using one today."
[Jump to whichever heart she's on]

-HEART 1
#If whoring 14 or less
	[Generic Akabur refusal]
#If whoring 15 or more and first time
	her "You want to watch me masturbate?" <s>
	her "Er...I have class to get to." <h>
	(...)
#If whoring 15 or more and not first time
	We have lot's to do today
(...)
[Choice]
	That's enough.
		m "Alright, you can go. Fifty points to Gryffindor."
		her "Uh, sir... Could you help me?" <n>
		">Genie waves his hand. The dildo erupts out of Hermione, who begins spasming in ecstasy again." <p_c> @sounds/magic2.mp3
		m "Now say thank you."
		her "Th...thaan...thank you...siiir." <a>
		m "Hurry along Miss Granger, I haven't got all day."
		">Hermione slowly rises off the floor and lurches out of the room on shaky legs."
		[End Scene]
		#If whoring less than 16 increase whoring by 1
	That gives me an idea...
		#If whoring 16 or more
			m "No, you leave that where it is."
			(...)
			[End Scene]
			[Make her come back at night]

-Night Time
[Random Chance (60% A; 30% B; 10% C)]

-A
m "Hello, Miss Granger."
her "..." <p>
(...)
[+50 points to Gryffindor]
[Jump to -Wrap Up]

-B
m "How do you feel?"
(...)
[-30 points from Gryffindor]
[Anger + 5]
[End Scene]

-C
m "You don't look too great."
(...)
[+50 points to Gryffindor and +30 points to Slytherin]
[Jump to -Wrap Up]

-Wrap Up
m "Well I'm glad you had fun."
her "Trust me, I did..."
(...)
[End Scene]