xdenizx / xray-16

Improved version of the X-Ray Engine, the game engine used in the world-famous S.T.A.L.K.E.R. game series by GSC Game World. Join OpenXRay! ;)

OpenXRay

OpenXRay is an improved version of the X-Ray Engine, the game engine used in the world-famous S.T.A.L.K.E.R. game series by GSC Game World.

Supported games

Call of Pripyat	Clear Sky	Shadow of Chernobyl
Yes	Release Candidate (see #382)	Not supported yet (see #392)

Build status

CI	Platform	Compiler	Configurations	Platforms	Status
AppVeyor	Windows, Ubuntu	MSVC, GCC	Debug, Mixed, Release, Release Master Gold	x64, x86
GitHub Actions	Windows, Ubuntu, Alpine Linux, macOS	MSVC, GCC, Clang	Debug, Mixed, Release, Release Master Gold	x64, x86
Travis	Ubuntu	GCC	Debug, Release	ARM64

Contributing

All contributions are more than welcomed. There are several ways how you can contribute:

Development

Join our efforts in making our beloved game better, send pull requests, participate in discussions and code reviews!

It is a place to share ideas on what to implement, gather people that want to work on the engine, and work on the source code. However, the following things should be taken into consideration:

• We want to keep the game as close as possible to the vanilla game, so instead of introducing new gameplay features, consider adding non-gameplay features, fixing bugs, improving performance and code quality.
• Major changes should be discussed before implementation.
• Follow the procedures.

Take a look at our Issues page:

• See issues labeled as good first issue to get familiar with the engine code in practice.
• You may also want to look at issues labeled as help wanted. Some of them are difficult ones, though.

The dev branch is the default and base branch for the project. It is used for development and all Pull Requests should go there. But, be aware that this branch, sometimes, may be broken and, rarely, we can do force pushes to this branch.

Be advised that this is a community project not sanctioned by GSC Game World in any way – and they remain the copyright holders of all the original source code and S.T.A.L.K.E.R. franchise.
However, they know about many community projects, including this, and support the S.T.A.L.K.E.R. community efforts to make the game better.

Community

Play and enjoy the game, file an Issue when you encounter any bugs, or you have an enhancement request.

Join us on our Discord, subscribe to our YouTube channel, join our VK group, leave a comment, put a like and communicate there!
Also you can put a star on this repository :)

Funding

You may provide financial support for this project by donating via GitHub Sponsors, Patreon or Open Collective.
Thank you for your support!

Documentation:

How to
Build and setup	On Windows	On Linux
Install and play	On Windows	-

Changelist and more is available in wiki.

Thanks

• GSC Game World – for creating S.T.A.L.K.E.R. and supporting the community;
• Loxotron – for making the engine sources available;
• All the OpenXRay contributors – for making the project better.
  • The first OpenXRay team (2014-2017) – for being at the origins of the project.
    • nitrocaster – original project founder.
    • Kaffeine – initial work on the Linux port, refactoring, polishing.
    • Armada651 – creation of the OpenGL renderer, work on the build system, other project maintenance work.
    • andrew-boyarshin – work on the build system.
    • Swartz27 – work on renderer features.
    • awdavies – project maintenance work.
  • The second OpenXRay team (2017-now) – for continuing work on the project.
    • Xottab_DUTY – current project leader.
    • intorr – work on the project quality. (memory leaks, refactoring, optimizations)
    • eagleivg – main part of the work on Linux port.
    • q4a – main part of the work on Linux port.
    • SkyLoader – OpenGL renderer improvements and polishing, other project work.
    • qweasdd136963 – supporting the OXR_COC project, other project work on new features, refactoring and bug fixing.
    • JohnDoe_71Rus – our regular tester.
    • Chip_exe – work on Linux port, maintaining AUR package, our regular tester.
    • a1batross – work on Linux port.
    • The Sin! – new features, refactoring, bug fixing polishing.
    • Zegeri – work on Linux port, code quality, fixes, polishing.
    • drug007 – work on Linux port.
    • vTurbine – work on renderer unification, refactoring, polishing.
    • Zigatun – work on ARM port.
    • Masterkatze – work on the build system, bug fixing.
  • Other contributors:
    • NeoAnomaly – for help with debug functionality on Windows.
    • RainbowZerg – for work on the renderer features, bug fixing.
    • FozeSt – for help with some fixes and features.
    • mrnotbadguy – for work on gamepads support and bug fixing.
    • ZeeWanderer – for work on the build system.
    • GeorgeIvlev – for work on the build system, bug fixing.
    • Plotja – for work on portability, polishing.
    • dimhotepus – for work on code quality.
• Particular projects:
  • Oxygen – for being our friends and giving tips and help with new features, optimizations, bug fixes, etc.
  • Shoker Weapon Mod and Shoker – for contributing new features, bug fixing.
  • Im-Dex – for the work on the engine.
  • OGSR – for amazing work on Shadow of Chernobyl.
  • Call of Chernobyl and its contributors – for useful new features, bug fixes and optimizations.
  • Lost Alpha – for their effort on restoring the old game concept.
  • Lost Alpha DC – for continuing work on Lost Alpha.
• Individuals:
  • tamlin-mike – for work on the build system.
  • Vincent – for work on the Linux port.
  • abramcumner – for useful fixes and additions.
  • Morrey – for work on Clear Sky support and his Return to Clear Sky mod.
• Companies:
  • CoderGears – thanks for providing a free Pro Licence for CppDepend, an amazing and powerful tool for C and C++.

If your work is being used in our project and you are not mentioned here or in the contributors page, please, write to us and we will add you.