Skip to content

Project Structure

github-actions[bot] edited this page Oct 12, 2025 · 1 revision

🗂️ Project Structure

Directory Overview

Illusion/
├── .github/              # GitHub workflows and configs
├── Animations/           # Battle animations
├── assets/              # Web assets and branding
├── Audio/               # Music and sound effects
├── Data/                # Compiled game data
├── docs/                # Documentation and wiki
├── Fonts/               # Game fonts
├── Graphics/            # Sprites, tilesets, UI
│   ├── Characters/      # Overworld sprites
│   ├── Pokemon/         # Pokémon sprites
│   ├── Tilesets/        # Map tiles
│   └── UI/              # User interface
├── PBS/                 # Plain text data files
│   ├── pokemon.txt      # Pokémon definitions
│   ├── moves.txt        # Move definitions
│   ├── items.txt        # Item definitions
│   └── ...
├── Plugins/             # Ruby plugins
│   ├── [001] Core/      # Core game systems
│   ├── [002] Battle/    # Battle mechanics
│   ├── [003] UI/        # User interface
│   └── ...
├── pokemon/             # Generated Pokédex pages
├── scripts/             # Development scripts
└── Text_*/              # Localization files

Key Files

Game Configuration

  • Game.ini: Main game configuration
  • mkxp.json: MKXP runtime settings
  • Game.rxproj: RPG Maker project file

Data Files (PBS)

  • pokemon.txt: Pokémon species data
  • moves.txt: Move definitions
  • items.txt: Item definitions
  • abilities.txt: Ability definitions
  • trainers.txt: Trainer data
  • encounters.txt: Wild Pokémon encounters

Graphics

  • Graphics/Characters/: Overworld sprites
  • Graphics/Pokemon/: Pokémon sprites (front/back/shiny)
  • Graphics/Tilesets/: Map tilesets
  • Graphics/UI/: Interface graphics

Audio

  • Audio/BGM/: Background music
  • Audio/BGS/: Background sounds
  • Audio/ME/: Music effects
  • Audio/SE/: Sound effects

Plugin System

Plugins are numbered for load order:

[001] Essential Core
[002] Battle System
[003] UI System
[100] Custom Feature 1
[200] Custom Feature 2

Plugin Structure

#===============================================================================
# [###] Plugin Name
#===============================================================================

module MyPlugin
  VERSION = "1.0.0"
  
  # Plugin code here
end

Compilation

  • scripts_extract.rb: Extract compiled scripts
  • scripts_combine.rb: Combine scripts back

Build System

Builds are created in build/ directory:

build/
└── Illusion-v1.0.0/
    ├── Game.exe
    ├── PBS/
    ├── Graphics/
    ├── Audio/
    └── ...

Development

Hot Reload

Most changes take effect after F12 (soft reset)

Debug Mode

Press F9 in-game for debug menu (development only)


Understanding the structure helps with development and troubleshooting!

Clone this wiki locally