Project Phoenix

Welcome to Project Phoenix — a groundbreaking project built with Unreal Engine 5 (UE5).

Overview

Project Phoenix is an open-source system designed to empower the CloneX community to equip, edit, and modify traits and wearables for their characters. This project represents the culmination of collective effort and resilience, symbolizing a new beginning for the community to guide its direction ahead.

Key Features

• High-Performance Graphics: Utilize UE5's Nanite and Lumen technologies for stunning visual fidelity.
• Local and Remote Backend: Compatible with local and remote backends for enhanced flexibility.
• Standalone Application: A downloadable standalone application is available for those who prefer an out-of-the-box experience.

Backend Information

This project can be paired with a local backend hosted from the https://github.com/RTFKT-Ltd/ProjectPhoenix-BEFE repository.

Getting Started

To set up Project Phoenix locally, follow these steps:

Prerequisites

• Unreal Engine 5 (latest stable version)
• Git
• Visual Studio 2022 (for Windows) or Xcode (for macOS)

Installation

# Clone the repository
git clone https://github.com/your-repo/project-phoenix.git

# Navigate into the project directory
cd project-phoenix

# Open the project in Unreal Engine

Running with Local Backend

To enable local backend functionality:

1. Clone the BEFE (https://github.com/RTFKT-Ltd/ProjectPhoenix-BEFE) repository.
2. Follow the backend setup guide provided in the BEFE repository.
3. Start the backend and run the UE5 project for full integration.

Real Documentation

The official and complete documentation for Project Phoenix is hosted on GitBook:

👉 https://project-phoenix.gitbook.io/documentation

The documentation includes:

• Detailed setup instructions.
• Download links for the standalone application.
• Advanced customization guides.

Contributing

We welcome contributions! If you're interested in helping out, please check out the contribution guidelines in the documentation. Be sure to fork the repository, make your changes, and open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

---

Thank you for being part of Project Phoenix! If you encounter any issues, please check the GitBook documentation or open an issue in the repository.