From f096680a7af764b68b358c3d110a0f2c27d323a6 Mon Sep 17 00:00:00 2001 From: Marcin Kurczewski Date: Fri, 4 Oct 2024 12:31:49 +0200 Subject: [PATCH] docs: post a merger notice --- README.md | 85 ++++++++----------------------------------------------- 1 file changed, 12 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index 545af2d..25a74cf 100644 --- a/README.md +++ b/README.md @@ -5,77 +5,16 @@ TR2X is an open-source decompilation project for Tomb Raider 2, created as a sequel to the successful [TR1X](https://github.com/LostArtefacts/TR1X/) project -for Tomb Raider 1. Our project is in the early stages, and our main focus is on -decompiling as much of the game as possible. +for Tomb Raider 1. -## The situation - -TR2X draws inspiration from existing decompilation efforts, including the -achievements of [TR2Main](https://github.com/Arsunt/TR2Main) developed by -[Arsunt](https://github.com/Arsunt/). However, we emphasize that TR2X is an -independent project and does not directly copy code from TR2Main. - -## Our Mission - -Our mission is to fully decompile Tomb Raider 2 and to eventually enhance the -overall gameplay experience. - -### Key Goals - -- **Comprehensive Decompilation:** - Our primary objective is to achieve a thorough decompilation of Tomb Raider - 2, enabling a deeper understanding of its inner workings. - -- **Enhancement of UK Box Version:** - Our work is based on the UK Box version of Tomb Raider 2. Eventually we hope - to reach feature parity with the Steam/multipatch version, and possibly - TR2Main as well. - -- **Cross-platform Compatibility:** - We are committed to making Tomb Raider 2 run natively on Linux, with the - possibility of supporting Mac systems in the future. - -- **Transparent Development Process:** - We value transparency and aim to maintain a transparent development process, - ensuring regular updates and engagement with the community. - -- **Changelog and Progress Updates:** - We strive to provide detailed and reliable changelogs, documenting - significant updates and changes made to TR2X. Additionally, we will keep - the community informed about the progress of the project. - -TR2X is currently in the early stages of development, focusing on the -decompilation process. We recognize that there is much work to be done. - -## Decompilation progress - -![](docs/progress.svg) - -## Improvements over original game - -#### Gameplay - -- added an option to fix M16 accuracy while running -- fixed killing the T-Rex with a grenade launcher crashing the game -- fixed secret rewards not displaying shotgun ammo - -#### Visuals - -- fixed TGA screenshots crashing the game - -#### Audio - -- fixed music not playing with certain game versions - -#### Mods -- added developer console (accessible with `/`, see [COMMANDS.md] for details) - -## Contributions - -Please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) file for more -information on how to contribute to the project. - -## License - -TR2X follows the GPL license. Please refer to the [COPYING.md](COPYING.md) file -for further details. +> [!NOTE] +> As of October 2024, this repository has been merged into the [TRX project](https://github.com/LostArtefacts/TRX). We invite you to join us at our new home. +> +> #### What you need to know +> +> - **Rationale**: This decision aims to simplify development, particularly feature and improvement sharing with TR1X. +> - **Repository Access**: This repository is archived. Future development and contributions will occur in the TRX project. +> - **Contributions**: Please submit issues, pull requests, and discussions to the TRX repository. +> - **Documentation**: Find all updated documentation and resources in the TRX repository. +> +> The LostArtefacts Team