DDLC Mod Template Python 3 Beta 2

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 #39

Full Changelog: Py3-Beta1...Py3-Beta2

DDLC Mod Template Python 3 Beta 1

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 #36
• possible 3.0.2 minor update by @GanstaKingofSA in #35

Full Changelog: 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.

DDLC Mod Template 3.0.1 - Eternal Plane of Life

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.

DDLC Mod Template 3.0.1 Beta 1 - Lunar Enlightement

⚠️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

DDLC Mod Template 3.0.0 - A Crane's Eternity

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.

DDLC Mod Template 2.5.0/3.0.0 Alpha 1 - The 4 Year Revamp

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.

DDLC Mod Template 2.4.9 - Unchanging Ei

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.

Recreation of the DDLC Act II Chapter 3 Monika Poem Scene with a Windows 10 BSOD.

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.

DDLC Mod Template 2.3.1 Update 8 - Constant Ei

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.

Recreation of the DDLC Act II Chapter 3 Monika Poem Scene with a Windows 10 BSOD.

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.

DDLC Mod Template 2.4.8 - Yae Ari

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.

DDLC Mod Template 2.3.1 Update 7 - Miko Ana

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.