Welcome to the DDLC Mod Template

This minor update for the mod template does the following.

Changes

• Replace obsolete appeal variable code after past template code upgrades.
• (Python 3) Decrease init state of gallery
• Changed screenshot code to fix a tear/invert bug in recent Ren'Py.

Selecting the right mod template

• If you are modding DDLC for the first time, download the DDLCModTemplate-4.2.4.zip file.

  It is recommended to mod DDLC on Ren'Py 7 if you use this version of the mod template. Do NOT mod on Ren'Py 6.

• If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.2.4-Py3.zip file.

Installation of both mod template versions are the same as all template installation steps.

If you are interested in downloading the Extra tools for the mod template, download either DDLCModTemplate-4.2.4-Extras.zip for normal versions of the mod template or DDLCModTemplate-4.2.4-Py3Extras.zip for Ren'Py 8 versions of the mod template.

Read the README file before installing anything and backup your mod.

Full Changelog: https://github.com/Bronya-Rand/DDLCModTemplate2.0/compare/4.2.3...4.2.4

Welcome to the DDLC Mod Template

This minor update for the mod template does the following.

Fixes

• (Python 3) Allow Tearing to be Saved [PR #73]

Changes

• Changed init timings for Achievements

Selecting the right mod template

• If you are modding DDLC for the first time, download the DDLCModTemplate-4.2.3.zip file.

  It is recommended to mod DDLC on Ren'Py 7 if you use this version of the mod template. Ren'Py 6 is NOT recommended to make your DDLC mods anymore. more info

• If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.2.3-Py3.zip file.

Installation of both mod template versions are the same as all template installation steps.

If you are interested in downloading the Extra tools for the mod template, download either DDLCModTemplate-4.2.3-Extras.zip for normal versions of the mod template or DDLCModTemplate-4.2.3-Py3Extras.zip for Ren'Py 8 versions of the mod template.

Read the README file before installing anything and backup your mod.

Welcome to the DDLC Mod Template

This update for the mod template does the following.

Features

• Added swipe support for Android devices (thanks to Tulkas)
• Reworked (to the best of my ability of keeping DDLC in tact) Poemgame system. (thanks to Elckarow and Psurae for some feedback)

For a guide on how to use the new poem game system, refer to Documentation/New Poemgame Guide.pdf or the DDMC Discord for more information.

Fixes

• Fixed a bug in the Python 2 branch due to Python 3 code existing over Python 2.
• Fixed a bug where mod extras features cause a ImportError by default due to different exception errors in Python 2.

Changes

• Added documentation for the new poem game in Documentation.
• Updated DDLC original script files to use new feature syntax.

Selecting the right mod template

If you are modding DDLC for the first time, download the DDLCModTemplate-4.2.2.zip file.

It is recommended to mod DDLC on Ren'Py 7 if you use this version of the mod template. Ren'Py 6 is NOT recommended to make your DDLC mods anymore. more info

If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.2.2-Py3.zip file.

Installation of both mod template versions are the same as all template installation steps.
If you are interested in downloading the Extra tools for the mod template such as Better BSODs, Better Tear Effect, Achievements, etc., download either DDLCModTemplate-4.2.1-Extras.zip for normal versions of the mod template or DDLCModTemplate-4.2.1-Py3Extras.zip for Ren'Py 8 versions of the mod template.

Read the README file before installing anything and backup your mod.

Welcome to the DDLC Mod Template!

This update brings semi-big changes to the mod template from the Heavensward update (4.2.0).

Features

• New Tear screen by @Elckarow (included under the new Extras and Py3Extras ZIP file)!
• New poem responses by @Elckarow!
• New mod template logo by RS/6000!

Changes

• Revert compact settings from Heavensward to Classic DDLC with setting tabs.
• Moved every mod extra out of the mod template.

  All mod extras can be re-added by downloading the Extras ZIP file for each respective build.

• Updated documentation of past legacy code that wasn't up-to-date.
• Added depreciation.rpy.

  This file is temporary and serves only as warnings to use newer features' code. This file may be removed at any time in a later update.

• Disabled Extras Menu and Translations by default.
• Add mod logo by default to the credits screen.
• Upgraded DSR/DSP.

Fixes

• Fixed an issue where the original credits file crashed due to the new console.
• Fixed an issue where window tabs errored out on some R6/R7 builds.

Hotfixes

• (Python 2) Fixed a bug relating to f-strings
• (Python 2) Fixed a bug relating to mod extra modules.

Full Changelog: https://github.com/GanstaKingofSA/DDLCModTemplate2.0/compare/4.2.0...4.2.1

Selecting the right mod template

If you are modding DDLC for the first time or are modding solely on Ren'Py 6 (not recommended) or 7 (recommended), download the DDLCModTemplate-4.2.1.zip file.
If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.2.1-Py3.zip file.

Installation of either mod templates are the same as usual.

If you are interested in downloading the Extra tools (Better BSOD, Better Tear Effect, Achievements, Gallery, etc.), download either DDLCModTemplate-4.2.1-Extras.zip (Python 2) or DDLCModTemplate-4.2.1-Py3Extras.zip (Python 3) respectively.

Read the README file before installing anything and backup your mod.

Welcome to the new DDLC Mod Template!

This new update brings semi-major changes, and features to the mod template.

Depreciation Warning

Ren'Py 6 support of the DDLC Mod Template is being put into question due to the lack of demand of Ren'Py 6 mods and to keep with the current Ren'Py development lifecycle. In the near future, new features and code will be focused on Ren'Py 7/8 then Ren'Py 6. It is recommended that you mod on Ren'Py 7 for future update. For more information, see this post.

Features

• New Gallery/Achievement System. Achievements hide their descriptions (optional), and both systems require less arguments than before!

  Old users of the Gallery/Achievement system will need to update their Achievement/Gallery classes if planning to upgrade.

• Vertical/Compact Framed Settings! More spacious settings screen with less bulk.
• (Python 3) New Discord RPC System! Use RPC even easily and more efficiently now with Enable/Disable. Thanks Lezalith!
• New Monika Console! Call in code more easily and efficiently with this new console system! Thanks Lezalith as well!
• Removed obsolete Help button.
• Fixed Act 3 Monika's Spaceroom. Thanks Psurae!
• Dynamic Super Resolution - Upscale your characters and art higher for higher resolutions.
• Dynamic Super Positions - Upscale your positions for higher resolutions.
• Player Name Change - You misspelt your name? Easy. Go to Settings, Extras and Change your name there!
• Custom Resolutions - Scale DDLC easily with preset resolution markers.

  Disabled by default. Comment out the code in screens.rpy to update it.

Changes

• Added depreciation warning to Ren'Py 6.

Fixes

• Fixed for loop for process list. - Elckarow Patch
• Fixed special poems listing. - Elckarow Patch

Reminders

Since 4.1.0, the mod template has changed how DDLC files are located which means that old guides, tutorials and such from 2017-Nov 22, 2022 will no longer apply to template versions 4.1.0 and higher. Please refer to the DDMC Discord or new guides/tutorials that state that they are compatible with the new mod template layout.

For mod guides/tutorials, please state whether the guide/tutorial is for the old template layout from 2017-Nov 22, 2022 or the new one that applies to the current 4.1.0 and beyond template

Selecting the right mod template

If you are modding DDLC for the first time or are modding solely on Ren'Py 6 (not recommended) or 7 (recommended), download the DDLCModTemplate-4.2.0.zip file.
If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.2.0-Py3.zip file.

Installation of either mod templates are the same as usual.

Welcome to the new DDLC Mod Template!

This new update brings major changes, and features to the mod template.

Features

• Added wiperight and wiperight_scene to DDLC
• Add dialog warning to users if they attempt to run the mod template as a mod by pressing the New Game button.

Changes

• Reorganized the mod template in full for a new modding experience

  This change will mean old guides, tutorials and such from 2017-Nov 22, 2022 will no longer apply to the template beyond 4.1.0. Please refer to the DDMC Discord or new guides/tutorials that state that they are compatible with the new mod template layout.
  For mod guides/tutorials, please state whether the guide/tutorial is for the old template layout from 2017-Nov 22, 2022 or the new one that applies to the current 4.1.0 and beyond template

• Changed how restore_all_characters(), delete_character(), and the poem game works for new layout compatibility.
• Re-added the old poem special labels for backwards compatibility with new poem special label calls.
• Updated Windows 11 BSOD to revert black to blue after a Windows Update.

Github Changelog

Full Changelog for Python 2: https://github.com/GanstaKingofSA/DDLCModTemplate2.0/compare/4.0.2...4.1.0
Full Changelog for Python 3: https://github.com/GanstaKingofSA/DDLCModTemplate2.0/compare/4.0.2...954b7952dc5a270f093ffb3c2515db0a30792d67

Selecting the right mod template

If you are modding DDLC for the first time or are modding solely on Ren'Py 6-7, download the DDLCModTemplate-4.1.0.zip file.
If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.1.0-Py3.zip file.

Installation of either mod templates are the same as usual.

Welcome to the DDLC Mod Template

This update addresses the following issues

Fixes

• Fixed a bug where LinuxLauncher.sh crashes if a screenshot file is present.
• [Python 3] Fixed a bug in effects.rpy due to Python 3 division.
• [Python 2] Fixed a bug with the process list on Mac/Linux.

Changes

• Fixed a possible line bug due to Composite vs im.Composite.
• [Python 3] Added a try except for Discord RPC if Discord is not present.
• Bump Lockdown to 8.0.3/7.5.3.

See the upgrade notes for this release before downloading/upgrading.

Selecting the right mod template

If you are modding DDLC for the first time or are modding solely on Ren'Py 6-7, download the DDLCModTemplate-4.0.2.zip file.
If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.0.2-Py3.zip file.

Installation of either mod templates are the same as usual.

Welcome to the DDLC Mod Template

This update addresses the following issues

Fixes

• [Python 3] Fixed a bug in relation to the Py 3 lockdown file
• [Python 2] Fixed a few things in relation to lockdown file
• [Python 2] Fixed a error in R6 relating to Composite.

See the upgrade notes for this release before downloading/upgrading.

Selecting the right mod template

If you are modding DDLC for the first time or are modding solely on Ren'Py 6-7, download the DDLCModTemplate-4.0.1.zip file.
If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.0.1-Py3.zip file.

Installation of either mod templates are the same as usual.

Welcome to the 4th Generation of DDLC Modding!

This brand new release of the mod template adds a ton of content into DDLC for easier modding and easier player guidance.

A note from the developer

All mods that use this template are required credit me in their mods' credits screen or credits.txt file. See README.md for more information. Thank your fellow mod tool developers for their hard work in these projects for you to make your own story possible!

Features

• Python 3! (Only available on the Py3 templates and must run on Ren'Py 8.0.0+. Add even more Python features to your mod for a better wow factor.
• Language Selector! Easily allow translators and players to switch between different languages for your mod before the game starts or whenever in the Settings Menu!
• (Python 3 Exclusive) [BETA] Discord RPC! Add Rich Presence into your mod that can run natively in Ren'Py!
• Credits Menu! Credit those that worked on your mod or helped get to where you are in the game in-game outside the end credits.

Changes

• (Python 3 Branch) Changed most of DDLC's python code to fit Python 3 code standards.
• Change error exceptions for missing DDLC RPAs or OneDrive location errors.
• (Python 3 Branch) Updated lockdown to prevent Py3 to run on R6-R7
• Updated lockdown to warn Py2 templates of running the template in Py3.

Fixes

• Fixed a few DDLC spawned bugs due to Ren'Py 8.
• Fixed lockdown

See the upgrade notes for this release before downloading/upgrading.

Selecting the right mod template

If you are modding DDLC for the first time or are modding solely on Ren'Py 6-7, download the DDLCModTemplate-4.0.0.zip file.
If you are modding DDLC on Ren'Py 8, download the DDLCModTemplate-4.0.0-Py3.zip file.

Installation of either mod templates are the same as usual.

Welcome to the new DDLC Mod Template!

This new beta release for the upcoming Ren'Py 8 release adds the following

Fixes

• Fixed a bug associated with the enabling/disabling feature of Discord Rich Presence.
• Fixed a bug related to certain effects to due depreciating arguments.

Changes

• Converted LiveComposite and im.Composite to Composite.
• Converted size(x,y) to xysize(x,y).
• Removed a compatibility layer from Gallery used only in Ren'Py 6.
• Adjusted imports and time they are imported to Ren'Py.
• Updated exception wording.

Github Changelog

• No ordereddict by @Elckarow in https://github.com/GanstaKingofSA/DDLCModTemplate2.0/pull/42
• update deprecated stuff by @Elckarow in https://github.com/GanstaKingofSA/DDLCModTemplate2.0/pull/43
• early rather than init by @Elckarow in https://github.com/GanstaKingofSA/DDLCModTemplate2.0/pull/44
• Update imports.rpy by @Elckarow in https://github.com/GanstaKingofSA/DDLCModTemplate2.0/pull/45

Full Changelog: https://github.com/GanstaKingofSA/DDLCModTemplate2.0/compare/Py3-Beta2...Py3-Beta3

Welcome to the new DDLC Mod Template!

This new beta release for the upcoming Ren'Py 8 and Mod Template update adds the following.

Changes

• Add Enable/Disable variables to enable/disable new template features without RPY removal.
• Add Discord Rich Presence
• Add Discord RPC docs

Github Changelog (for those who want it)

• Cyrillic support and Version Dash Improvement by @NekoLaiS in https://github.com/GanstaKingofSA/DDLCModTemplate2.0/pull/39

Full Changelog: https://github.com/GanstaKingofSA/DDLCModTemplate2.0/compare/Py3-Beta1...Py3-Beta2

Welcome to the new DDLC Mod Template!

This Python 3 beta release is the first beta release to support Python 3 support within the upcoming Ren'Py 8.

Features

• New Reworked Gallery
• Language Options

Fixes

• Fixed a crash where the poemgame was unable to split the words due to it being read in byte mode.

Changes

• Readjusted a few lines of Python code to Python 3 equivalents.
• Moved all RPY imports to a file named __imports__.rpy.
• Changed Linux BSOD to fit the new Python 3 changes.
• Removed a few patches due to them being specific to Ren'Py 7.
• Added exceptions.rpy to control better error management in splash.rpy and lockdown_check.rpy.

Github Changelog (for those who want it)

• New Gallery by @GanstaKingofSA in https://github.com/GanstaKingofSA/DDLCModTemplate2.0/pull/36
• possible 3.0.2 minor update by @GanstaKingofSA in https://github.com/GanstaKingofSA/DDLCModTemplate2.0/pull/35

Full Changelog: https://github.com/GanstaKingofSA/DDLCModTemplate2.0/compare/3.0.1...Py3-Beta1

As always, this is a beta. This mod template, nor Ren'Py 8 should be used to make a final mod. Please wait until a actual release of Ren'Py 8 and the mod template is released.

Welcome to the new DDLC Mod Template!

This new update to the mod template brings the following new features, changes and fixes to the DDLC Mod Template.

Starting from 3.0.0, you may only use the DDLC Mod Template to create DDLC mods or translations of this template.

A note from the developer

All mods that use this template are required to either use the stock presplash.png image in the game folder or make a custom presplash image that contains a readable Template provided by GanstaKingofSA logo in it which can be found here along with credit in a mods' credits.txt file or credits screen. Thank your fellow mod tool developers for their hard work in these projects for you to make your own story possible!

Features

• Extras Menu! A new screen to simplify screen buttons in the main menu!

Fixes

• Fixed a bug where os was missing on launch.
• Patched wmic environment variables.
• Patched Monika's Space Room effects.

  This patch however will disable OpenGL 2 if your mod uses it as this is the main reason why the effects break. You can decide to disable this patch in renpy_patches.rpy.

Changes

• Depreciated locked in Gallery for unlocked.
• Added Artist tag in gallery.
• Changed Achievements name to Awards.
• Added new syntax for R6 Android mod writing.
• Added missing DDLC 1.1.1 update code to the template.
• New error wording explaining RPA error in splash.rpy.
• Added error for the mod template if the mod/mod template is in OneDrive (due to compatibility issues)
• Changed Achievements and Gallery from lists to dicts.
• Moved new features RPY files to mod_extras and images into mod_assets/mod_extra_images.

  If you are upgrading from 2.4.6-3.0.0, please make sure to transfer your old code to the new files pathway and remove their respective files from the game folder.

• Revamped the pronoun system for any pronouns.

New Fix

• Added presplash.png to scripts.rpa.

⚠️This release is in beta. ⚠️

Do not build mods on this version of the mod template until the final release is out.

This beta release adds the following testing features, patches and changes.

Features

• Extras Menu. A menu designed to add additional features into your mod without cluttering the main menu.

Changes

• Moved Achievements and Gallery Button to new Extras menu.
• Renamed Achievements to Awards due to name clipping.
• Add artist tag to Gallery.

Patches

• Patched wmic environment variables
• Patched Monika's Space Room Effects

Welcome the 3rd generation of the DDLC Mod Template and of DDLC modding! This major update introduces the following features, fixes and changes.

Note: Starting from 3.0.0, you may only use the DDLC Mod Template to create DDLC mods. You may not use it to make unofficial patches/fixes to DDLC.

Features

• Achievements Menu! Set up achievements in your mod and notify the user of a unlocked achievement in-game!
• Gallery Menu! Showcase the art in your mod outside of the mod's story for players to see.

  Players can export only backgrounds from the mod to use for a PC background. If you wish to not have this, remove the E textbutton in gallery.rpy

• Different Menu Button Colors! Have different colored buttons in the menu prompt to your hearts content.

  Examples on how to use this are in screens.rpy

• Automatic GUI Coloring! Color the GUI in the game to whatever you like without editing the asset files themselves!

  Examples and code to use this feature are in splash.rpy and screens.rpy respectively.

• Export your mod logo as a ICO file for your executables! (Windows Only)
• Uncensored Mode! Allow adult/sensitive content to players that wish to see the following content.

  To hide uncensored details, refer to this example

    if persistent.uncensored_mode:
        m "Uncensored Content"
    else:
        m "Censored Content"

• Let's Play Mode (Streamer Mode)! Protect dokitubers, streamers and more from having their information leaked (names, etc.) in-game!

  To hide player info details, refer to this example

    if persistent.lets_play:
        m "Hi MC!"
    else:
        m "Hi John!"

Fixes

• Made a Linux/MacOS SH Launcher (LinuxLauncher.sh) to fix the future.standard_library issue that occurs from installing a Ren'Py 7 mod over DDLC.
• Fixed a bug where the poemgame under Ren'Py 6 will error out due to different syntax requirements.
• Patched the long causing Ren'Py 7.4.6-7.4.8 transform bug where several characters may not appear or transitions are broken in script.
• Patched the Ren'Py 7.4.9 menu animation bug where the menu polka-dots would reset themselves each time a menu button was clicked.
• Fixed a bug where os was missing in splash.

Changes

• Removed the scripts.rpa requirement from splash.rpy due to defined twice errors.
• Fixed process listing due to wmic's depreciation in Windows 10 and 11 builds > 22000 and for MacOS/Linux support.
• Fixed Better BSODs due to wmic's depreciation in Windows 10 and 11 builds > 22000.
• Updated template comments.

For a guide on using the newest features, see this Google Doc.

Welcome to the first alpha release of the DDLC Mod Template. This release plans to add the following to either the 2.5.0 or 3.0.0 update of the mod template when I decide which version number is adequate.

Features

• Achievements (PR #17)
• Gallery Menu (PR #12)
• Different Color Menu Buttons (PR #18)
• Automatic GUI coloring (color the in-game GUI without replacing assets) (PR #16)
• Uncensored Mode (PR #12)
• Let's Play Mode (PR #12)
• Support to make a ICO file for your mod (Windows) (PR #12)

Fixes

• Fixed the poemgame for Ren'Py 6 Android mods. (PR #12)
• Removed the scripts.rpa requirement in splash.rpy (PR #12)
• Fixed the Ren'Py 7.4.6 - 7.4.8 transform bug (PR #14)
• Fixed a bug in Ren'Py 7.4.10 where transitions reset their animations (main menu bg bug) (PR #14)

Let me know which version number is more adequate for this update.

A note from the developer

This release is alpha meaning it's a testing release that may be prone to bugs. DO NOT INSTALL THIS OVER A RELEASED MOD TEMPLATE OR YOUR EXISITING WORK! Rather make a copy of it or a new copy of DDLC and install it over that and run the game to test out the alpha update. Do not build mods for this version of the mod template.

A request from the developer

If the template has been useful to you, please credit me in your mods' release. Not all mod tool developers are thanked as much as regular mod teams by people outside the modding community and it will be appreciated to credit those that put the effort into making modding easier for you to make your own mod for others to enjoy.

Features

• Better Blue Screens Of Death! This feature allows modders to make their own Blue Screen of Deaths easily in the game itself rather than make multiple static images of the same screen with a different text and a customizable QR code (Windows 10 - 11 BSOD only)!

  BSODs available for all operating systems from Windows 7 to Windows 11, including MacOS/OS X and Linux.
  To change the QR code, replace the file frame.png within mod_assets. Make sure the QR is black so the screen can color it like Windows does.

To use this feature do show screen bsod(bsodCode="Your message code"). Available syntax is

show screen bsod(bsodCode="Your message code", bsodFile="Your fake file that crashed", rsod=False)

rsod can be chanded to be True or False. Doing so will trigger a red screen of death if the user is on Windows 11. Thanks Jacob from TSC!
To hide the screen, do hide screen bsod.

• Ren'Py 7.4.9 and 7.4.10 are now supported! No longer are these versions suffering from the broken transforms that 7.4.6 and 7.4.8 had. These versions should be OK to mod on.
• Updated Android guide slightly for now to update the new 7.4.9 - 7.4.10 working versions and new Google Play Protect pop-up.

A request from the developer

If the template has been useful to you, please credit me in your mods' release. Not all mod tool developers are thanked as much as regular mod teams by people outside the modding community and it will be appreciated to credit those that put the effort into making modding easier for you to make your own mod for others to enjoy.

Features

• Better Blue Screens Of Death! This feature allows modders to make their own Blue Screen of Deaths easily in the game itself rather than make multiple static images of the same screen with a different text and a customizable QR code (Windows 10 - 11 BSOD only)!

  BSODs available for all operating systems from Windows 7 to Windows 11, including MacOS/OS X and Linux.
  To change the QR code, replace the file frame.png within mod_assets. Make sure the QR is black so the screen can color it like Windows does.

To use this feature do show screen bsod(bsodCode="Your message code"). Available syntax is

show screen bsod(bsodCode="Your message code", bsodFile="Your fake file that crashed", rsod=False)

rsod can be chanded to be True or False. Doing so will trigger a red screen of death if the user is on Windows 11. Thanks Jacob from TSC!
To hide the screen, do hide screen bsod.

• Ren'Py 7.4.9 and 7.4.10 are now supported! No longer are these versions suffering from the broken transforms that 7.4.6 and 7.4.8 had. These versions should be OK to mod on.

A request from the developer

If the template has been useful to you, please credit me in your mods' release. Not all mod tool developers are thanked as much as regular mod teams by people outside the modding community and it will be appreciated to credit those that put the effort into making modding easier for you to make your own mod for others to enjoy.

Features

• [BETA] Pronoun Support! Allow players to be called by their preferred pronoun in-game using pronoun defined variables in your script/story!

  See pronouns_example.rpy in the game folder for a example on how to use the pronoun feature in your mod.

Updates

• Blacklisted all Ren'Py versions above 7.4.5 for now as all versions (as of 7.4.8) still contain a transformation bug in the engine.

  It's semi-fixed in 7.4.7 but hiding does not work well on these versions which is something I see as a quality defect for mods on these versions.

Features

• [BETA] Pronoun Support! Allow players to be called by their preferred pronoun in-game using pronoun defined variables in your script/story!

  See pronouns_example.rpy in the game folder for a example on how to use the pronoun feature in your mod.

Updates

• Blacklisted all Ren'Py versions above 7.4.5 for now as all versions (as of 7.4.8) still contain a transformation bug in the engine.

  It's semi-fixed in 7.4.7 but hiding does not work well on these versions which is something I see as a quality defect for mods on these versions.