Skip to content

Commit

Permalink
Added FAQ with references in the Readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
therationalpi committed Dec 12, 2017
1 parent f4d96b0 commit 7407100
Show file tree
Hide file tree
Showing 2 changed files with 129 additions and 4 deletions.
119 changes: 119 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Frequently Asked Questions (FAQ)

**Table of Contents**

[Installation](#installation)

[Contributing](#contributing)

[DDLC Modding](#general-ddlc-modding)

[Features](#features)

[Other Help](#other-help)

## Installation

### What do I need to play *Monika After Story*?

You will need a copy of *Doki Doki Literature Club*, which can be downloaded for free either on Steam or at http://ddlc.moe, and the zip file containing the mod files for *Monika After Story*, which can be found on the release page.

You do not need to download the source code from either the release page or from the repository. Those files are for development purposes only and may behave in unexpected ways if placed in your DDLC folder.

### Where do I put the files for *Monika After Story*?

The files for *Monika After Story* must be placed directly in the `game` folder of *Doki Doki Literature Club* in order for the game to find and properly load them. To find the folder containing *DDLC*, do one of the following:

If the game was installed using Steam, right click on *Doki Doki Literature Club* and click on `Properties`. In the window that pops up navigate to the `Local Files` tab and click the button for `Browse local files...`.

If the game was installed from http://ddlc.moe or itch.io, the installation location was chosen at setup, but is likely under Program Files on a Windows computer.

If the game was installed on mac, but not through the Steam client, *Doki Doki Literature Club* can be found as a packaged app in you Applications folder. Right click on the package and select "Show Package Contents" once inside the folder, navigate to `Contents/Resources/autorun/`. This folder is the base directory for DDLC.

Once inside the base directory, place the contents of the zip archive into the `/game` directory. Ensure that the files are not in a subfolder in the `game` directory, since DDLC will not be able to locate the files that way.

### I installed the mod, but when I open *Doki Doki Literature Club* nothing has changed. What's wrong?

For some reason *Doki Doki Literature Club* is not loading the mod files. Check that the files are not inside a subfolder inside your `game` directory.

### When I try to open the game, it crashes and I see a gray screen. How do I fix this?

If the game crashes and returns a gray screen, that means that a major error has occurred and the game had to quit. The text shown is called a "Traceback" and will hopefully include an error message that will help diagnose the problem. This traceback file can also be seen by viewing `traceback.txt` in your game's DDLC base directory.

While some crashes may indicate a bug in the game, a few may indicate a problem with installation.

If the traceback includes:

```
Exception: DDLC archive files not found in /game folder. Check installation and try again.
```

Ensure that the original archive files for DDLC are still in the game folder. This will include `images.rpa`, `scripts.rpa`,`audio.rpa` and `fonts.rpa`. If these files are missing, then they will need to be replaced using a fresh installation of DDLC, downloaded from http://ddlc.moe

If the traceback includes a line like the following:

```
The label chara_monika_scare is defined twice, at
```

Then it is likely that developer files have been installed, instead of the release distribution. Ensure that the game files downloaded were from the latest release, found on our [Release Page](https://github.com/Backdash/MonikaModDev/releases), and that the file downloaded was the mod zip file and *not* the Source Code.

## Contributing

### I have an idea on how to improve Monika After Story, where do I suggest it?

We're always happy to hear new ideas! Suggestions can be made on our issues page. Please preface all suggestions with [Suggestion], or follow [this link](https://github.com/Backdash/MonikaModDev/issues/new?labels=suggestion&body=Your%20suggestion%20goes%20here&title=%5BSuggestion%5D%20-%20) which will automatically populate your suggestion with the appropriate tags.

### I would like to contribute, but I don't know how to code. Is there any way I can help?

We are always looking for new dialogue and art. Please see our [Contributing Guide](https://github.com/Backdash/MonikaModDev/blob/master/CONTRIBUTING.md) for information on how to submit new dialogue and art to Monika After Story. In this guide you will find tips on writing good dialogue in Monika's style, and learn how to open a "Pull Request" which will allow you to submit new topics for review and inclusion in the game.

### Where can I find things to help with?

Our issues page will show a list of technical issues, new features, and requests that are available. Anything with the [Help Wanted](https://github.com/Backdash/MonikaModDev/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) tag is a good place to start if you would like to help add something to the game!

### How can I get in touch with the development staff?

The easiest way to contact our dev team is through our [Discord channel](https://discord.gg/7P5DnJ4).

## General DDLC Modding

### Is it possible to make my own DDLC mod?

Yes! DDLC has a vibrant modding community, thanks in part to Team Salvato's very clear [IP Guidelines](http://teamsalvato.com/ip-guidelines/). To get started building your own mod, you can download the [DDLC Mod Template](https://github.com/therationalpi/DDLCModTemplate) and [join in the community on reddit](https://www.reddit.com/r/DDLCMods/).

### Can I use parts of Monika After Story in my own project?

In general, we are very open to assets and code from *Monika After Story* being used in other projects. However, we do hope that anyone who wishes to do so respect these requests:

Please follow Team Salvato's [IP Guidelines](http://teamsalvato.com/ip-guidelines/) for any project which includes our work.

Please consider contacting our development team to ask permission before using our work.

Please give credit to Monika After Story for the work that you use and link back to our project at http://www.monikaafterstory.com/. Do not claim ownership of the work others have done. Where applicable, please give individual credit for things like art assets used.

Do not make a mod or fork intended as a replacement for *Monika After Story*. If you would like to add new features or content to the game, please make those contributions to the original project. We are very open to suggestions and contributions, and odds are that anything added would be welcomed. If, for some reason, your new features conflict with the direction for Monika After Story consider developing your changes in the form of a "submod" which can be added to Monika After Story.

## Features

While we are very open to new suggestions, there are a few common suggestions that come up often. These suggestions have all been made previously and will either be implemented in a future release or have been rejected for some reason:

### Is there a list of keywords to see all topics?

We don't want to spoil Monika's dialogue by offering a list of the keywords. Additionally, a new system for selecting topics to discuss with Monika will be available in an upcoming version, rendering keywords obsolete. If you really want to look up keywords, they can be found in the script-topics file in this repository.

### Will we ever be able to add our own music to the game?

We do not have plans to include custom music in the music selector. Not only does this pose a technical issue because of the engine's preference for .ogg format files that most people don't have, but it is largely unnecessary as you can always play *Monika After Story* with the game music muted while listening through some other program. Unfortunately this means that having Monika comment on your personal music collection will also not be implemented.

### Why is the text entry feature being removed?

While we may come back to the concept in the future, the fact is that we weren't happy with the interactivity with the keyword system. While, on the surface, the open text box offered a lot of freedom to the player for talking with Monika, there were too many common entries that would simply dead end. The result was that Monika felt less real, and more like a crappy chatbot. We decided that a system that didn't dead end would be better, even if it didn't have the same surface level impression of agency.

### Hey, could we make Monika a real chatbot AI?

While we might come back to the idea in the future, for the moment it doesn't seem feasible to make an AI that can give the sort of detailed philosophical responses that Monika should give. A large part of this is technical limitations in the engine for connecting to outside resources and importing custom libraries.

## Other help

Don't see the answer that you're looking for here? Please [create an issue](https://github.com/Backdash/MonikaModDev/issues) to ask a tech-support question or file a bug report. You can also get help from members of our community on the [tech-support channel on discord](https://discord.gg/WE65rQ3).
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ If you would like to make your own mod like this one, check out our sister proje

*NOTE: Source files and files downloaded directed from the repository are for development purposes and may not behave as expected if used to mod the game. Please only use one of our [Release Versions](https://github.com/Backdash/MonikaModDev/releases).*

For more help with installation, please see our [Frequently Asked Questions](https://github.com/Backdash/MonikaModDev/blob/master/FAQ.md)

### Features

* Spend forever with Monika!
Expand All @@ -35,12 +37,12 @@ If you would like to make your own mod like this one, check out our sister proje


## Contributing to Monika After Story

### Bugs & Suggestions
If there are issues with MAS, please file a [bug report](https://github.com/Backdash/MonikaModDev/issues/new?labels=bug&body=Describe%20bug%20and%20steps%20for%20reproduction%20here&title=%5BBug%5D%20-%20).

To add a suggestion, visit [this link](https://github.com/Backdash/MonikaModDev/issues/new?labels=suggestion&body=Your%20suggestion%20goes%20here&title=%5BSuggestion%5D%20-%20)

### Other Help
Want to help with MAS? Navigate to the [issues page](https://github.com/Backdash/MonikaModDev/issues) to find current bugs or suggestions to work on.

Expand All @@ -53,7 +55,7 @@ Want to add some content to MAS? Here's a list of important .RPY files the game
- **script-ch30.rpy**: Script for Monika's room. Contains all the opening dialogue, events, etc.
- **script-topics.rpy**: All topics used by Monika are written here. You can add your own dialogue by checking the information below!
- **script-greetings.rpy**: Add lines for Monika to greet you when loading the game.
- **splash.rpy**: Handles the splash screens seen in-game.
- **splash.rpy**: Handles the splash screens seen in-game.

If you wish to add more dialogue to the space room, navigate to script-topics.rpy and use this template.

Expand All @@ -80,7 +82,11 @@ For things more complicated than simple dialogue, consult the Ren'Py documentati

### Join the conversation
If you want to actively participate in contributing to/building this mod, [join the Discord server!](https://discord.gg/7P5DnJ4). You can also [follow us on twitter](https://twitter.com/MonikaAfterMod) for game updates, and a constant stream of our favorite Monika-related content from around the web. Please be sure to follow our [Code of Conduct](https://github.com/Backdash/MonikaModDev/blob/master/CODE_OF_CONDUCT.md), which is essentially to be courteous and respectful.


## Frequently Asked Questions

A full FAQ is available here: [Frequently Asked Questions](https://github.com/Backdash/MonikaModDev/blob/master/FAQ.md)

## License info

We do our best to conform to Team Salvato's [guidelines for fan works](http://teamsalvato.com/ip-guidelines/). All characters and original content are property of Team Salvato. Monika After Story is an open source project, and in addition to named contributors, this mod includes contributions from anonymous users of 4chan, where this project got its start. More info can be found on our [License Page](https://github.com/Backdash/MonikaModDev/blob/master/LICENSE.md).

0 comments on commit 7407100

Please sign in to comment.