Home - shawna-p/mysterious-messenger GitHub Wiki

Introduction

The docs have moved! (see below)

Welcome to Mysterious Messenger, a messenger game created in Ren'Py. As of version 3.0+, all of the documentation has now been moved to https://mysterious-messenger.readthedocs.io/en/stable/

The pages here are for v2.2 of Mysterious Messenger. You can find more up-to-date docs on this version here: https://mysterious-messenger.readthedocs.io/en/v2.2.1-docs/ However, it is highly recommended you use the most recent version of Mysterious Messenger from the Releases tab!

(Original intro)

Welcome to Mysterious Messenger, a messenger game created in Ren'Py. This guide was created to help users understand how the program works together, and how to take advantage of the various functions.

This guide is best used by navigating to the sections with the information you need as you need it rather than reading it from start-to-finish. Most sections have a line at the top that says "Example files to look at"; these will usually show the features described in the guide in action in the program itself. As much as possible, the code has been annotated to help you understand what's happening in the program. Additionally, you'll find plenty of code excerpts in this guide itself. They look like this:

## Sample code here

Most of these code excerpts are taken directly from the program itself and can be copied in to use for your own test purposes. Some sections will also have a "quick-start" guide at the beginning; they look like this:

A brief overview of the steps required (more detail below):
  1. Step 1
  2. Step 2
    1. Step 2a

If you just need a quick reminder of what to do to get some code up and running, you can refer to this. If you need more detail, however, the rest of that section will explain further.

If you haven't already, you should also play through the Tutorial Day in the program at least once to get a feel for what the program is capable of. Then, if you're new to Ren'Py and/or to programming, you should take a look at the Beginner's Guide, which will take you through the steps to make the first chatroom of a new route playable.