Bronya-Rand / DDModDocker

Codename: Snowrance. A WIP mod launcher integrated into DDLC/Ren'Py.
GNU Affero General Public License v3.0
21 stars 2 forks source link
ddlc ddlc-mod ddlc-mods mod mod-loader mod-manager mod-menu modding

Doki Doki Mod Docker

DDMD Logo

Doki Doki Mod Docker is a Ren'Py application designed to streamline the management and play of multiple Doki Doki Literature Club (DDLC) mods. It effectively 'containerizes' mods, allowing them to run independently within a single copy of Ren'Py/DDLC.

[!IMPORTANT] This project is currently in alpha. You may encounter bugs or compatibility issues with certain mods. To report mod incompatibility, report it either in Issues.

[!NOTE] This project is unaffiliated with Team Salvato. See BUILDING.md on how to build Mod Docker with fixes for Pull Requests. Credits for DDMD can be seen by looking at CREDITS.md.

Features

Custom Background Instructions

  1. Place a 16:9 image into Mod Docker's game directory.
  2. Name the image docker_custom_image.

Installation

[!IMPORTANT] For macOS Users: These steps require you to access the directory within the Mod Docker app. Right-click the Mod Docker app, select Show Package Contents, then navigate to Contents/Resources/autorun.

  1. Download the latest version of Mod Docker here.
  2. Extract Mod Docker to a location of your choice.

    [!CAUTION] Avoid installing directly over DDLC

  3. Download DDLC's PC ZIP from ddlc.moe and extract the ZIP file.
  4. Locate the DDLC-X.X.X-pc/game folder and copy the following files to Mod Docker's game folder:
    • audio.rpa
    • fonts.rpa
    • images.rpa
    • scripts.rpa
  5. Create a mods folder within Mod Docker's game folder.
  6. Inside the mods folder, create a subfolder for each mod you wish to install

    [!TIP] Suggested Mod Folder Naming Scheme: Mod's Full Name or Acronym

  7. Copy the game folder from the desired mod into its respective subfolder within the mods folder.

    [!IMPORTANT] If the mod lacks a game folder, create one inside the mod's subfolder and place all mod files (RPAs, RPYCs, etc.) within.

  8. Launch Mod Docker using DDMD.exe (Windows), DDMD (macOS), or DDMD.sh (Linux).
  9. Press F9 to access the Mod Docker menu. Select your mod and click Select.
  10. Restart the game and relaunch Mod Docker.

Why Mod Docker?

What inspired Mod Docker?

Mod Docker draws inspiration from the earlier vision of the Doki Doki Mod Launcher (DDML), conceived in 2018. While limitations existed in DDML's initial implementation, Mod Docker revisits that core concept, refining it for practicality and ease of use. It draws on the modularity principles of Docker to create a streamlined solution that aligns with standard modding practices.

How does a 'mod container' work?

A diagram of how mod container works

Think of a mod container as a self-contained space within Mod Docker. It houses all the necessary files for a specific mod, including RPAs, RPYC/RPY's, and folders like mod_assets. When you select a mod, Mod Docker loads only the files from its dedicated container.

Comparing Mod Docker to Other Mod Launchers/Managers

Mod Docker takes a unique approach to mod management compared to other mod managers/launchers. Here's a breakdown of key differences:

A diagram comparing Mod Docker to Doki Doki Mod Launcher/Mod Manager and Standard Installs

Mod Docker

Doki Doki Mod Launcher/Doki Doki Mod Manager

Standard Install

Copyright © 2022-2024 Azariel Del Carmen (Bronya-Rand). All rights reserved. Licensed under GNU AGPL-3.0. See LICENSE for more information.