Add README.md
This commit is contained in:
111
README.md
Normal file
111
README.md
Normal file
@@ -0,0 +1,111 @@
|
||||
# FCE360 — Archived Mirror (Xbox 360 NES/Famicom Emulator)
|
||||
|
||||
This repository preserves **FCE360**, an Xbox 360 port of the NES/Famicom emulator, as it originally appeared on Google Code.
|
||||
**No changes** have been made to the uploaded files (including original Visual Studio/XDK project folders).
|
||||
The goal is **historical preservation** and ease of access for research.
|
||||
|
||||
> **Status:** Archived / Unmaintained
|
||||
> **Upstream:** Google Code (defunct) → mirrored here
|
||||
> **License:** GPL-2.0-or-later (see source headers / included license files)
|
||||
> **Structure:** Subversion-style layout (trunk/branches/tags/wiki)
|
||||
|
||||
---
|
||||
|
||||
## What's in this repo
|
||||
|
||||
This repository contains the complete source code for FCE360 in a Subversion-style layout:
|
||||
|
||||
- **`trunk/fce360/`** — Main source code directory
|
||||
- `fceux/` — Core emulator source code (FCEUX-based)
|
||||
- `fceux/` — FCEUX emulator core (CPU, PPU, mappers, input, etc.)
|
||||
- `xbox/` — Xbox 360-specific implementation (audio, video, input, UI)
|
||||
- `media/` — UI assets (XUI files, images, effects)
|
||||
- `utils/` — Utility code (unzip support)
|
||||
- `fceux.sln` — Visual Studio 2008 solution file
|
||||
- `lib/` — Third-party libraries
|
||||
- `zlib-1.2.5/` — Compression library (included)
|
||||
- **`branches/`** — Empty (no branches in this snapshot)
|
||||
- **`tags/`** — Empty (no tags in this snapshot)
|
||||
- **`wiki/`** — Wiki documentation directory
|
||||
|
||||
Original project layout as retrieved; nothing removed or modified.
|
||||
|
||||
---
|
||||
|
||||
## About FCE360
|
||||
|
||||
FCE360 is a homebrew port of a NES/Famicom emulator to Xbox 360, originally by **Ced2911** and contributors.
|
||||
It uses the Xbox 360 homebrew toolchain (XDK/XUI/Direct3D 9-era projects) and depends on the FCEU/FCEUX codebase.
|
||||
|
||||
**Credits (historical):**
|
||||
- Port & Xbox 360 frontend: **Ced2911** (and community contributors)
|
||||
- Core emulator: **FCEU / FCEUX** teams
|
||||
- Additional third-party libraries (e.g., zlib/libpng) under their respective licenses
|
||||
|
||||
If you are a rights holder and want attribution adjusted or content removed, please open an issue.
|
||||
|
||||
---
|
||||
|
||||
## Building (historical reference)
|
||||
|
||||
> **Note:** Building requires legal access to the Xbox 360 XDK and appropriate SDK components.
|
||||
> Neither binaries nor SDK files are provided or linked here.
|
||||
|
||||
Typical historical setup:
|
||||
1. Windows with **Visual Studio 2008** (VC9; the project file targets this version).
|
||||
2. Xbox 360 **XDK** with XUI and D3D9 support installed and configured.
|
||||
3. **zlib-1.2.5** is included in `lib/zlib-1.2.5/` (no external copy needed).
|
||||
4. **SDL** may be referenced in include paths but is not included in this repository.
|
||||
|
||||
To build:
|
||||
1. Open `trunk/fce360/fceux.sln` in Visual Studio 2008.
|
||||
2. Select the Xbox 360 platform and desired configuration (Debug/Release).
|
||||
3. Resolve any missing dependencies (e.g., SDL if referenced).
|
||||
4. Build the solution.
|
||||
|
||||
Project paths and exact SDK version expectations come from the original snapshot and may need local path fixes.
|
||||
|
||||
---
|
||||
|
||||
## Running (for archival releases)
|
||||
|
||||
This repository contains source code only. To run on an Xbox 360:
|
||||
1. Build the project using the instructions above to generate `default.xex`.
|
||||
2. Copy the built executable and required media files to your RGH/JTAG console (e.g., `Hdd1:\_Emus\fce360\`).
|
||||
3. Ensure all media assets from `fceux/media/` are included with the build.
|
||||
4. Launch `default.xex` from your file manager (Aurora/Freestyle/etc.).
|
||||
5. Place your **legally owned** ROMs in the emulator's expected `roms` folder (path varies by build).
|
||||
6. Some features may require additional BIOS/data files not provided here (do not request or upload them).
|
||||
|
||||
Because this is an archival snapshot, UI, controls, and paths may differ from other forks. Use the in-app UI/help.
|
||||
|
||||
---
|
||||
|
||||
## Why preserve this?
|
||||
|
||||
- Google Code is gone; many console homebrew projects became hard to find.
|
||||
- Keeping an **unaltered** snapshot helps researchers verify provenance, reproduce builds, and compare ports.
|
||||
|
||||
If you fork this for active development, please clearly label your fork and document your changes.
|
||||
|
||||
---
|
||||
|
||||
## Legal
|
||||
|
||||
- Code in this snapshot is **GPL-2.0-or-later** unless a file states otherwise.
|
||||
- Third-party libraries retain their original licenses.
|
||||
- Xbox 360 XDK is proprietary. Do **not** ask for SDK files or links.
|
||||
|
||||
---
|
||||
|
||||
## Contributing to this mirror
|
||||
|
||||
This repository intentionally mirrors an original drop.
|
||||
If you spot metadata errors (description, dates) or want to add context documents (read-only), open an issue.
|
||||
For functional changes, please fork to keep this mirror pristine.
|
||||
|
||||
---
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
Thanks to the original authors and the preservation community for keeping classic console homebrew accessible.
|
||||
Reference in New Issue
Block a user