diff --git a/README.md b/README.md index e2c9adc..4efdc0a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,22 @@ # malfunction -A first 3D game made using "Castle Game Engine" and Blender and VRML models. Done a long time ago (before 2004). Please *do not* use the sources of this game as an example how to use "Castle Game Engine" --- we use here a lot of old, deprecated and uncomfortable ways to deal with 3D stuff! +## This is a very old application; do not use this to learn Castle Game Engine! -Complete documentation on http://castle-engine.sourceforge.net/malfunction.php . +This application was developed using a very old _Castle Game Engine_ version. It still builds with the latest engine version (it is even tested by [GitHub Actions](https://castle-engine.io/github_actions) to make sure we maintain backward-compatibility) but it's absolutely *not* how I would go about implementing this game type now. -Using Castle Game Engine, see http://castle-engine.sourceforge.net/ . +*Do not use this game as a learning example.* Instead, get [latest Castle Game Engine](https://castle-engine.io/) and browse `examples` inside the installed engine. + +This project is maintained here only: +- for historical purposes +- and as part of automated test to make sure we maintain backward-compatibility when developing new engine versions. -## Big TODO +## Introduction -**Do not use this code a basis for your projects. It uses really outdated Castle Game Engine API with outdated (deprecated) direct OpenGL fixed-function access.** This is not a way to render on modern GPUs, and this is not a way to use Castle Game Engine :) +A first 3D game made using "Castle Game Engine" and Blender and VRML models. Done a long time ago (before 2004). Please *do not* use the sources of this game as an example how to use "Castle Game Engine" --- we use here a lot of old, deprecated and uncomfortable ways to deal with 3D stuff! + +Complete documentation on http://castle-engine.sourceforge.net/malfunction.php . -This project is only for historical purposes. +Using Castle Game Engine, see http://castle-engine.sourceforge.net/ . ## License