Getting Started

Setting Up Your Environment

1. Fork the Repository: Start by forking the repository on GitHub and then cloning it to your local machine.

   git clone https://github.com/your-username/touhou_bot.git
   cd touhou_bot

2. Set up a Virtual Environment: It is recommended to use a virtual environment to manage dependencies.

   python -m venv .venv
   source venv/bin/activate  # On Powershell or cmd use `.\venv\Scripts\activate`

3. Install Dependencies: Install the required Python packages.

   pip install -r requirements.txt

   For the Touhou Bot Test Tool, you need to install additional dependencies:

   pip install -r requirements-test.txt

Structure of the Project

The project is organized into several directories, each serving a specific purpose:

touhou_bot/
├── .vscode/               # Visual Studio Code settings
├── checkpoints/           # The models that interrupts training
├── conf/                  # Configuration files
├── doc/                   # Documentation files
├── models/                # The path to store models
├── resource/              # The path to store the resource files
├── src/                   # Source code for the Touhou Bot
|    ├── agent/            # Agent and environment module
|    ├── config/           # Configuration module
|    ├── gamebase/         # Base classes for game-specific implementations
|    ├── perception/       # Perception modules
|    └── web/              # Web APIs
├── tests/                 # Unit tests
├── utils/                 # Additional tools and scripts
├── logo.png               # Project logo
├── pytest.ini             # Pytest configuration
├── requirements.txt       # Main dependencies
├── requirements-test.txt  # Dependencies for testing
├── run.py                 # Running the application with Web UI
└── README.md              # Project documentation

Workflow of the Project

TODO: Describe the workflow of the project.