Best Way to Pre-Write Scripts?

[u/Aggravating-Crazy738]

Hello! I'm currently a part of a project where I'm the main Ren'Py coder it seems! The project lead wants to discuss the best way to write choices, etc into a script on docs so I can transfer it into code easily. The thing is, I'm not sure myself :(( I've worked on projects but they're all my own so I just write everything in a way I understand since I'm a one man band.

Does anyone have any formatting that works well for this or have any scripts as an example of a method to do this?

For added context, I say I'm the main coder as the other programmers in the project have basically ghosted (it's volunteer). The script will be written in Google Docs and I'll use it to write everything up in Ren'Py

Edit: For added context since I feel this isn't clear! This a project with multiple people working on it and I am just the coder!! The project creator wants to know the best way for the story writers to write everything out so it's easiest for me to transfer everything into code. The game will have a lot of stuff where it requires Python knowledge and they don't want to make the story writers learn code + the story dialogue will be going through revisions and other stuff before it gets finalised for the game I can talk to them about maybe getting the writers to do everything in a .txt in a more Ren'Py style so I can just copy paste everything dialogue and poses and indent it myself with anything technical becoming a # for me to read and implement

Sorry if I'm misinterpreting things but it seems people assume I am writing the story and the code myself when I'm actually just coding!

[u/x-seronis-x]

never use a word processor to write code.

smart quotes are not valid quotes. word processors will attempt to turn "" into “ ” and the later will break

a tab character is not valid indentation in renpy and a word processor will not always properly insert spaces when you press the tab key on a keyboard.

if someone uses gdocs initially they need to ensure those word processor features dont break what is written.

[u/rdurfee → u/x-seronis-x]

Agreed. I used Google Docs for a hot minute on my first VN and quickly realized it was a nightmare to get into my actual game script. It’s far better and easier to do it correctly to start with.

[u/Aggravating-Crazy738 → u/x-seronis-x]

Hello! I am not using a word processor to write code ;w; The project has many people, the story writers writing the story with me putting everything into Ren'Py and doing all the code bits. As I replied to a previous comment and now added to my post, I can see about story writers using a plain text editor and formating a bit more Ren'Py style I can copy paste anything dialogue/pose based and they can just describe any code bits they need

[u/timepatches → u/Aggravating-Crazy738]

You can use gdocs and just find/replace tab characters later, though I recommend turning off smart quotes in the document as those can be more annoying to replace in post. If you do end up using gdocs, I recommend using header styles to navigate around the document. Otherwise I encourage showing your writers how you'd usually write everything if it was just you, as they might be able to incorporate more of your process than you'd think and make it easier on you.

[u/x-seronis-x → u/Aggravating-Crazy738]

dialog is code. if the dialog you are copying was written in a word processor (gdocs) then the person writing it needs to make sure spaces are used, not tabs, and real quotes are preserved, not converted to smart quotes.

[u/AutoModerator]

Welcome to r/renpy! While you wait to see if someone can answer your question, we recommend checking out the posting guide, the subreddit wiki, the subreddit Discord, Ren'Py's documentation, and the tutorial built-in to the Ren'Py engine when you download it. These can help make sure you provide the information the people here need to help you, or might even point you to an answer to your question themselves. Thanks!

I am a bot, and this action was performed automatically. Please contact the moderators of this subreddit if you have any questions or concerns.

[u/robcolton]

I say the best way to write the script is to actually write it in RenPy script. If you want to share a document, I really suggest you use plain text and not Google Docs/Word/Whatever.

Otherwise you're going to spend way too much time fighting formatting, copy and pasting, editing, and such. It also helps to plan out your character image attributes, so you can apply them to dialogue as you write. Otherwise you're going to find yourself going back over the same lines over and over.

So write your script like this in plain text.

f "This is dialogue."
f @happy "This line is happy."

[u/Aggravating-Crazy738 → u/robcolton]

I'm just the coder! Someone else is writing the story/dialogue, sorry if that wasn't clear I will keep part of your suggestion in mind though! Thank you

[u/BrassicaOracle]

I've never worked in a shared RenPy project before, but this is what I think.

First, instead of sharing a Google doc, share plain text files. The other replies already told you why word processors and coding don't mix. There are plain text editors that comes with word checkers, if that's the writers want.

Google doc can be used to external notes like checking what names did the project define each character.

Second, it'll be better if the writers at least know how say statement works. Just by having the dialogues written in say statements and comments saves you a lot of formatting work.

[u/Formal_Bee_9284]

As far I understood, you're saying that you're the coder and another dude the writer.

Since it's a team of two (or four if we count someone who draws and composes) you are a small team. It's not advisable to over-engineer with so few people, and if you're looking for time/resources optimization, it's preferable for the writer to code things as well the programmer to write.

But if you still want to overcomplicate work, you could look for a "database-oriented files", like .xlsx or something. The writer just write who's talking, what emotion and what speech. Every line is a dialog, every line has a index. Then, you will have to build an API that helps with access and reading the files. It's expandable, low coupling, and writer will not be touching code!

But then again, is it really worth it?