From 92ed644f430aa9ad9f3843fb2d12baac287461ca Mon Sep 17 00:00:00 2001 From: Marco Hladik Date: Tue, 22 Dec 2020 00:18:15 +0100 Subject: [PATCH] Add README.md --- README.md | 61 +++++++++++++++++++++++++++ doc/fte.svg | 96 ++++++++++++++++++++++++++++++++++++++++++ doc/idtech.svg | 110 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 267 insertions(+) create mode 100644 README.md create mode 100644 doc/fte.svg create mode 100644 doc/idtech.svg diff --git a/README.md b/README.md new file mode 100644 index 00000000..5af7f015 --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# ![FTE Logo](doc/fte.svg) Nuclide - Software Development Kit + +Software Development Kit, built around idTech with focus on advanced features and +clean-room implementations of true-and-tested game-logic frameworks. + +All of this is written in QuakeC, but there's also some GLSL and shell scripts +in here. + +You can integrate an engine (FTE) and level design tool (WorldSpawn) directly from this tree. *See the 'Building' section for details.* +They're the projects actually based on idTech (GPL) code and therefore are in their own repositories. +**All the code here is ISC-Licensed.** + +The advantage of our centralized model is that the toolchain more or less integrates +with the engine seamlessly. This avoids a common problem developers have of trying to +use tools primarily designed for one specific idTech game with a custom +engine that's trying to do more advanced stuff than the former. + +## Building +The 'build_engine.sh' script checks out the **FTE Subversion** repository and keeps it up to date, +while also building binaries that are crucial to running and building the game-logic +(which is all QuakeC) and putting them into the ./bin directory. +Launch the engine with the 'nuclide' and 'nuclide-ds' scripts. + +The 'build_editor.sh' script clones the **WorldSpawn** Git repository and installs them into the ./bin directory. +Use the 'worldspawn' and 'vmap' scripts to launch to ensure consistency. + +The 'build_game.sh' script will build the game-logic for the games included +using the QuakeC compiler present in the ./bin directory. +If the compiler isn't found it will ask you to build them. + +For best results, symlink the desired scripts into your home directory's bin folder. +The scripts are designed to be aware of their actual location in the filesystem. + +## Support +Join us on irc.vera-visions.com and chat if you're interested in using this in production. +**All this is provided to you for free as-is otherwise.** + +## Special Thanks +To id software and specifically John Carmack for having released the sources of +various idTech games under the GPL2 license, without which we would have no engine for Nuclide. + +David Walton for **FTEQW** and the **FTEQCC** compiler, which is the brain of this SDK. + +Timothee Besset and the **GtkRadiant** contributors. + +![idTech Logo](doc/idtech.svg) + +## License +Copyright (c) 2016-2020 Marco Hladik + +Permission to use, copy, modify, and distribute this software for any +purpose with or without fee is hereby granted, provided that the above +copyright notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER +IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING +OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/doc/fte.svg b/doc/fte.svg new file mode 100644 index 00000000..cd850d5d --- /dev/null +++ b/doc/fte.svg @@ -0,0 +1,96 @@ + + + FTE Logo + + + + image/svg+xml + + FTE Logo + 2018 + + + Marco Hladik + + + + + + + + + + + + + + + + + + diff --git a/doc/idtech.svg b/doc/idtech.svg new file mode 100644 index 00000000..3266de49 --- /dev/null +++ b/doc/idtech.svg @@ -0,0 +1,110 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + +