tfm-architecture

Explain the Terraforming Mars project's three-layer architecture and directory structure.

Updated Feb 11, 2023
One-click install
npx skills add https://github.com/Ender-Wiggin2019/elo --skill tfm-architecture
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: tfm-architecture
Source: https://github.com/Ender-Wiggin2019/elo/tree/main/.agents/skills/tfm-architecture
Command: npx skills add https://github.com/Ender-Wiggin2019/elo --skill tfm-architecture

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers understand the complex architecture and file structure of the Terraforming Mars (TFM) project, enabling efficient navigation and development.

Core Features & Use Cases

  • Codebase Navigation: Understand the directory structure, server/client/common layer interactions, and file locations.
  • Development Guidance: Learn about project request conventions, API implementation standards, and the card rendering system.
  • Use Case: A new developer joins the TFM project and needs to understand where to find the logic for card effects and how to implement a new API endpoint. This Skill provides the necessary overview.

Quick Start

Explain the directory structure of the TFM project.

Frequently Asked Questions about tfm-architecture

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I navigate the Terraforming Mars codebase architecture?

The Terraforming Mars codebase uses a three-layer architecture: common, server, and client. This overview details directory structures, server-client interactions, and file locations to help you find logic efficiently.

What is the project structure of the Terraforming Mars game?

The Terraforming Mars project structure is divided into three layers: common, server, and client. It separates shared logic, backend API endpoints, and frontend card rendering systems across distinct directories for clear organization.

How do I implement a new API endpoint in the Terraforming Mars project?

To implement a new API endpoint in the Terraforming Mars project, follow its specific request conventions and API standards. The server layer handles these interactions, which are detailed in the architecture guide.

Where can I find the card rendering system logic in the TFM codebase?

The card rendering system logic in the TFM codebase is located within the client layer. The architecture guide explains how this frontend system interacts with the common and server layers to display game effects.

Do I need to understand the three-layer architecture to contribute to the TFM project?

Yes, understanding the three-layer architecture of common, server, and client is essential for contributing to the TFM project. It provides the necessary overview of directory structure and API conventions for efficient development.