Home

Awesome

<div align="center"> <p> <a href="https://github.com/OpenXRay"> <img src="misc/media/OpenXRayCover.png" alt="Open for everyone" /> </a> </p> </div> <h1 align="center"> OpenXRay </h1>

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.

Goals

  1. Make it a drop-in replacement for original engine.
    1. Aim at 99% compatibility and same behaviour, where possible.
    2. Compile engine into a single executable file that you can just drop into bin folder. (see #210)
  2. Support all three games in the series: SOC/CS/COP. (see Supported games below)
  3. Fix original S.T.A.L.K.E.R. series bugs.
  4. Introduce a solid platform for modmakers:
    1. Add frame/render graph for those who want to add new graphics features.
    2. Improve performance via refactoring the code, parallelizing the engine, making it multithreaded.
    3. Add new scripting, development and debugging features.
    4. New game SDK with new features.
  5. Clean up engine code, make it easily portable to new platforms, minimize platform-specific code.
  6. Enhance player's experience with new graphics, gameplay and other features that can be enabled optionally. (by default, we stay close to vanilla)

Main differences from original X-Ray are:

You can see the detailed differences table here

Supported games

OpenXRay is based on X-Ray 1.6.02, used in S.T.A.L.K.E.R.: Call of Pripyat, so initially it supported only this game. <br> Currently, we are working on support for all three games in the series.

Call of PripyatClear SkyShadow of Chernobyl
YesRelease candidate (see #382).<br>Minor bugs possible, but game is stable finishable.Not supported yet (see #392)

Documentation:

Make sure to visit our wiki.

How to
Build and setupOn WindowsOn Linux
Install and playOn Windows-

Build status

CIPlatformCompilerConfigurationsPlatformsStatus
AppVeyorWindows, UbuntuMSVC, GCCDebug, Mixed, Release, Release Master Goldx64, x86AppVeyor Build status
GitHub ActionsWindows, Ubuntu, Alpine Linux, macOSMSVC, GCC, ClangDebug, Mixed, Release, Release Master Goldx64, x86GitHub Actions Build Status
TravisUbuntuGCCDebug, ReleaseARM64Travis Build Status

Contributing

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

Community

Discord

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! <br> Also you can put a star on this repository :)

Development

Contributors

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:

Take a look at our Issues page:

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 we can only rarely 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.

Funding

Financial Contributors Sponsors Patreon

You may provide financial support for this project by donating via different ways:

Thank you for your support!

Thanks

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. Or send us a pull request with you added to this list ;)