Skip to content

README-original.md

Latest commit

 

History

History
71 lines (56 loc) · 5.2 KB

README-original.md

File metadata and controls

71 lines (56 loc) · 5.2 KB

Welcome to the New Python 3 Modification Club!

ko-fi

Download the Mod Template Here!

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

For Ren'Py 6-7 support, see the Python 2 branch.

The template can be downloaded/forked/used to create DDLC mods, make translations for other languages (with name credit) or submit fixes via a pull request. 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 GanstaKingofSA's DDLC Mod Template 2.0: https://github.com/GanstaKingofSA/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 GanstaKingofSA logo (which can be found here).
  2. A small mention in the game's disclaimer saying that this mod was not possible without using GanstaKingofSA's mod template.
  3. A presplash screen that contains a GanstaKingofSA logo (which can be found here).
  4. Present a custom idea to me for approval either through Discord or Reddit.

Team Salvato Disclaimer

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.

Template Features

  1. Build Packaging on Ren'Py 8!
  2. Team Salvato compliant splash screen.
  3. DDLC's exact RPY files with explainations.
  4. macOS .app and Linux support via LinuxLauncher.sh.
  5. Android Support! Bring your mod over to a mobile platform!*

    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.

  6. 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 ›

  7. [BETA] Pronoun Support! Allow players to identify with the pronoun they go by!

    See mod_extras/pronouns.rpy in the game folder for a example on how to use this feature.

  8. Better Blue Screens of Death! Make your own BSOD easily in-game on every operating system!
  9. Uncensored Mode! Allow more sensitive content to be shown in-game.
  10. Let's Play Mode (Streamer Mode)! A better alternative to hide streamer information and more!
  11. Gallery Menu! Allow players to see the work you have done in-game and export it!
  12. Achievements Menu! Set up achievements in your mod for players to complete your mod in full!
  13. Different Menu Button Colors! Have different colored buttons in the menu prompt to your hearts content.
  14. Automatic GUI Coloring! Color the GUI in the game to whatever you like without editing the asset files themselves!
  15. Extras Menu! Add additional button options to your game for additional button options!
  16. Terra's in-depth Poem Game guide!
  17. NVL Support thanks to Yagamirai01!
  18. Patches for several Ren'Py releases and Windows features.
  19. Python 3 code now in use!
  20. [BETA] Discord Rich Presence support!

Returned Features

  1. Ghost Menu. (Dan's spooky easter egg)
  2. Sayori Kill Script. (If you delete Sayori before the game starts, a new screen takes over)
  3. Monika Kill Script. (If you delete Monika after the game loads, a new script plays out)
  4. Special Poems! (The random poems in DDLC that appear in Act 2)
  5. Poem Responses! (The Doki's respond to your poems!)

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, check only Ren'Py 8 DDLC Compliant Mod and click Build. This will create a cross-platform Renpy8-DDLCMod ZIP file with your mod files.

Getting Started For Android Porting/Modding

Refer to guide.pdf 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-2022 Azariel Del Carmen (GanstaKingofSA). 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.