Skip to content

Repository files navigation

TOTC: Think Of The Children - Development Project

TOTC Logo

"Won't somebody please think of the children?!" - Helen Lovejoy, The Simpsons

Project Zomboid Mod Version React TypeScript Vite License

Complete development environment for the TOTC Project Zomboid mod, including web tools and comprehensive documentation

Mod FeaturesWeb AppInstallationDevelopmentProject StructureContributing


Overview

This repository contains the complete development environment for TOTC: Think Of The Children, a Project Zomboid mod that adds child-sized zombies to the game. The project includes:

  • Project Zomboid Mod: The core mod files with Lua scripts, configurations, and translations
  • Web Application: A React/TypeScript web app built with Vite for mod management and tools
  • Comprehensive Documentation: 22 documentation files covering installation, publishing, and technical details
  • Publishing Guides: Step-by-step guides for Steam Workshop and GitHub releases

Mod Features

The TOTC mod introduces child-sized zombies to Project Zomboid:

  • Configurable Spawn Rate: Control what percentage of zombies spawn as children (default: 10%)
  • Adjustable Size: Set how small child zombies are compared to adults (default: 50%)
  • Sandbox Integration: Easy configuration through the game's built-in Sandbox Options
  • Multiplayer Ready: Works seamlessly in singleplayer and multiplayer servers
  • Build 42 Compatible: Uses the new Build 42 mod structure (common/ + 42/ folders)
  • Lightweight: Minimal performance impact - uses OnTick for reliable zombie processing
  • Bilingual: Includes English and Spanish translations
  • No Dependencies: Works standalone without requiring other mods

For detailed mod information, see TOTC_ThinkOfTheChildren/README.md


Web App

The included web application provides tools and utilities for mod development and management:

  • Mod Configuration Tool: Interface for testing and previewing mod settings
  • Documentation Viewer: Integrated documentation browser
  • Development Utilities: Tools for mod development workflow

Tech Stack

  • Frontend: React 18 with TypeScript
  • Build Tool: Vite
  • Styling: Tailwind CSS
  • Icons: Lucide React
  • Backend: Supabase (optional, for data persistence)

Installation

Prerequisites

  • Node.js 18+ and npm
  • Project Zomboid (for testing the mod)
  • Git for version control

Clone and Setup

  1. Clone the repository:

    git clone https://github.com/yourusername/TOTC_ThinkOfTheChildren.git
    cd TOTC_ThinkOfTheChildren
  2. Install dependencies:

    npm install
  3. Start development server:

    npm run dev
  4. Build for production:

    npm run build

Mod Installation

For Project Zomboid mod installation, see docs/INSTALL.txt or TOTC_ThinkOfTheChildren/README.md


Development

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run lint - Run ESLint
  • npm run typecheck - Run TypeScript type checking

Project Structure

├── TOTC_ThinkOfTheChildren/     # Project Zomboid mod files
│   ├── Contents/mods/TOTC.../   # Mod content (Steam Workshop structure)
│   │   ├── common/              # Shared assets (required, even if empty)
│   │   │   └── media/           # Common media folder
│   │   └── 42/                  # Build 42 specific files
│   │       ├── mod.info         # Mod metadata with pzversion=42.x
│   │       └── media/           # Lua scripts, translations, etc.
│   ├── media/                   # Original assets
│   ├── README.md                # Mod documentation
│   ├── LEEME.md                 # Spanish documentation
│   └── workshop.txt             # Steam Workshop metadata
├── docs/                        # Documentation
│   ├── INSTALL.txt              # Installation guide
│   ├── TECHNICAL.md             # Technical documentation
│   └── PUBLISHING.md            # Publishing guide
├── src/                         # Web application source
│   ├── components/              # React components
│   ├── pages/                   # Application pages
│   └── ...
├── public/                      # Static assets
├── package.json                 # Node.js dependencies
├── vite.config.ts               # Vite configuration
└── README.md                    # This file

Contributing

We welcome contributions to both the mod and the web application!

For the Mod

  • Report bugs or suggest features in Issues
  • Submit pull requests for improvements
  • Help with translations or testing

For the Web App

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-feature
  3. Make your changes and test thoroughly
  4. Submit a pull request

Development Guidelines

  • Follow the existing code style
  • Add tests for new features
  • Update documentation as needed
  • Ensure compatibility with Project Zomboid Build 42/43

See docs/CONTRIBUTING.md for detailed contribution guidelines.


Publishing

See docs/PUBLISHING.md for guides on publishing to GitHub and Steam Workshop.


License

This project is licensed under the MIT License - see TOTC_ThinkOfTheChildren/LICENSE for details.

The Project Zomboid mod and associated assets are provided as-is for educational and entertainment purposes.


Acknowledgments

  • Project Zomboid by The Indie Stone
  • Helen Lovejoy from The Simpsons for the inspiration
  • The Project Zomboid modding community

Made with ❤️ for the Project Zomboid community

About

TOTC: Think Of The Children - "Won't somebody please think of the children?!" - Helen Lovejoy, The Simpsons

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages