Files
WinDurango/README.md

73 lines
3.9 KiB
Markdown

<p align="center">
<a href="https://github.com/WinDurango-project/WinDurango/">
<img alt="WinDurango logo" src="https://raw.githubusercontent.com/WinDurango-project/WinDurango/main/assets/logo/1024.png" height="120px">
</a>
</p>
<h1 align="center">WinDurango</h1>
[![Join our Discord](https://img.shields.io/discord/1280176159010848790?color=2c9510&label=WinDurango%20Discord&logo=Discord&logoColor=white)](https://discord.gg/mHN2BgH7MR)
[![GitHub contributors](https://img.shields.io/github/contributors/WinDurango/WinDurango?color=2c9510&label=Contributors)](https://github.com/WinDurango/WinDurango/graphs/contributors)
[![GitHub Repo stars](https://img.shields.io/github/stars/WinDurango/WinDurango?color=2c9510&)](https://github.com/WinDurango/WinDurango/stargazers)
Check out the UI project at [WinDurango.UI](https://github.com/WinDurango-project/WinDurango.UI/)
WinDurango is an experimental compatibility layer and emulator for **Xbox One** games on Windows. It aims to recreate the console environment so titles can run natively on PC hardware. Development is still in its early stages.
<p>
<a href="https://www.youtube.com/watch?v=SZMLML7yZns">
<img alt="WinDurango logo" src="https://img.youtube.com/vi/SZMLML7yZns/0.jpg">
</a>
</p>
> [!NOTE]
> This project is still being worked on, and we **really** need help as we only have a few developers.
> If you know C++ and think you can help out, hop into the Discord and let us know. :)
Come chat with us on our [Discord](https://discord.gg/mHN2BgH7MR).
For developer chat join `#developer` but stay on topic. Lurking is not only fine, but encouraged!
Discussing illegal activities, such as piracy, (illegal) hacking, doxxing/cyberbullying, and all other forms of copyright infringement will get you banned.
## Status
[![GitHub Latest Release](https://img.shields.io/badge/Latest-Release-green?color=2c9510&)](https://github.com/WinDurango/WinDurango/releases)
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/WinDurango/WinDurango/msbuild.yml?label=Nightly&color=2c9510&)](https://github.com/WinDurango/WinDurango/actions)
The project's long term goal is to run commercial Xbox One titles on PC hardware through a free and open-source compatibility layer.
Currently, only **Minecraft: Xbox One Edition** runs with WinDurango.
See the [Game compatibility list](https://windurango.github.io/Documentation/playable-games.html)
for currently tracked games.
## Getting Started
Check out [Running Games With WinDurango](https://windurango.github.io/Running-a-Game) on our documentation.
## Releases
Head over to the [releases page](https://github.com/WinDurango/WinDurango/releases) for stable builds.
Stable builds are manually curated snapshots that have gone through basic
testing. Nightly builds are generated automatically from the latest commits and
may contain unfinished features or regressions. If you run into issues while
using a nightly build, please report them on the
[issue tracker](https://github.com/WinDurango/WinDurango/issues).
## Disclaimer
The goal of this project is to experiment, research, and educate on the topic
of emulation of modern devices and operating systems. **It is not for enabling
illegal activity**. All information is obtained via reverse engineering of
legally purchased devices and games and information made public on the internet
(you'd be surprised what's indexed on Google...). We are not any way affiliated
with Microsoft.
## Contributors Wanted!
Have some spare time and know C++? Help build the world's first Xbox One compatibility layer!
Check the [open issues](https://github.com/WinDurango/WinDurango/issues) and the
[good first issue](https://github.com/WinDurango/WinDurango/labels/good%20first%20issue) label,
then come chat with us on [Discord](https://discord.gg/mHN2BgH7MR) before starting work.
## License
WinDurango is licensed under the [GNU General Public License, version 3](LICENSE.txt).