Skip to content

Latest commit

 

History

History
102 lines (70 loc) · 6.29 KB

README.md

File metadata and controls

102 lines (70 loc) · 6.29 KB
Raw

Welcome to the New Modification Club!

The new DDLC Mod Template is a mod template made by Azariel Del Carmen (bronya_rand) for the original Doki Doki Literature Club that adheres to Team Salvato's IP Guidelines for fan mods on Ren'Py 6.99.12.4 and 7.3.5+.

Additionaly here are all the contributors that contributed to the mod template.

For Ren'Py 8 support, see the Python 3 branch.

Disclaimers

  • Team Salvato

    The template code/files are designed for original DDLC fan games and mods that use DDLC assets with Ren'Py. It is not meant for non-DDLC projects. The DDLC Mod Template is not afilliated in anyway with Team Salvato.

  • bronya_rand

    You may not use the template to make unofficial DDLC patchers, fixes, etc.

Credit Requirements

You must include a name credit in your mods' credits screen and/or credits.txt file. Below is a example credit you may use.

This mod was made possible by bronya_rand's DDLC Mod Template 2.0: https://github.com/Bronya-Rand/DDLCModTemplate2.0

By default a credits screen is enabled in-game, either in the Extras screen or as a button in-game if the Extras screen is disabled.

Optional but very appreciated credits that you can also add are

  1. A custom splash screen that features the Team Salvato logo (and/or your mod logo) and a Bronya Rand logo (which can be found here).
  2. A small mention in the game's disclaimer saying that this mod was not possible without using bronya_rand's mod template.
  3. A presplash screen that contains a Bronya Rand logo (which can be found here).
  4. Present a custom idea to me for approval either through Discord or Reddit.

Template Features

  1. Ren'Py 6* or 7 Team Salvato Compliant Mods and Splashscreen (Disclaimer)!

    * - Ren'Py 6 support will end soon to keep up with Ren'Py's Development Lifecycle. It is highly recommended you upgrade to Ren'Py 7 for mod development. Learn more.

  2. DDLC's exact RPY files with explainations.

  3. Support for macOS, Linux* and Android**!

    * - Linux users must run your mod via LinuxLauncher.sh.

    ** - If your mod uses simple code or DDLC functions. More complex code or non-mobile friendly features may require some adjustments to get working. See guide.pdf or visit the DDMC Discord for additional help.

  4. Xcode Support! Open this project in Xcode and you can edit, build, and run your mod without opening the Ren'Py Launcher ever again!

    Note: You need to change your RENPY_TOOL location and the Ren'Py app location in the target scheme for Xcode. Learn more ›

  5. Uncensored Mode and Let's Play Mode! - Allow more "sensitive" content to be shown in-game and protect your IRL information while streaming/recording!

  6. Automatic GUI Coloring and Different Menu Button Colors! - Color the GUI and/or menu buttons in the game to whatever you like without editing the asset files themselves!

  7. Terra's in-depth Poem Game guide!

  8. NVL Support thanks to Yagamirai01!

  9. Patches for several Ren'Py releases and Windows features.

  10. Dynamic Super Resolution/Dynamic Super Positions (DSR/DSP) and Custom Resolutions! - Scale positions and/or your assets higher than they usually can go and display DDLC in different resolution modes. The DDLC Mod Template is now a universal X resolution template!

  11. Player Name Change! - Did you wrongly typed your name or want to change it? You can now do so very easily!

  12. New Monika Console and Poem Responses! - Enjoy a easier console to type commands in and a cleaner, easier poem response!

  13. Improved effects!

In addition to these base features, the template comes with additional optional features you can use such as

  • [BETA] Pronoun Support! - Allow players to identify with the pronoun they go by!
  • Better Blue Screens of Death! - Make your own BSOD easily in-game on every OS!
  • Gallery and Achievements Menu! - Allow players to see the work you have done in-game and earn achievements for playing your mod!

Returned Features

  1. Ghost Menu. (Dan's spooky easter egg)
  2. Sayori Kill Script (plays if Sayori is deleted before the game starts).
  3. Monika Kill Script (plays if Monika is deleted before a new game starts).
  4. Special Poems! (The random poems in DDLC that appear in Act 2) [now improved!].

Getting Started

Follow the steps listed here in order to install the mod template.

Once you finished writing your script, select Build Distributions. Uncheck all the options and check only the version of Ren'Py's "DDLC Compliant Mod" Option (Ren'Py X DDLC Compliant Mod) i.e. 'Ren'Py 7 DDLC Compliant Mod' for Ren'Py 7 and click Build. This will create a cross-platform mod package ZIP file with your mod files.

  • Ren'Py 6 Mods are classified with the -Mod ending in the ZIP filename.
  • Ren'Py 7 Mods are classified with the -Renpy7Mod ending in the ZIP filename.
  • Ren'Py 8 Mods are classified with the -Renpy8-DDLCMod ending in the ZIP filename.

Getting Started For Android Porting/Modding

Refer to The DDLC Android Mod Guide for more in-depth information about making your mod work on Android.

For older templates, refer to the PDF in your templates' ZIP file as the latest guide may not match your current template.

Copyright © 2019-2024 Azariel "Bronya Rand" Del Carmen (bronya_rand). All rights reserved.

Doki Doki Literature Club, the Doki Doki Literature Club code, is the property of Team Salvato (Dan Salvato LLC). Copyright © 2017 Team Salvato. All rights reserved.