tech

nuclide

Nuclide SDK - an idTech based game development framework http://www.vera-visions.com/nuclide/

Go to file

Marco Cawthorne ddce7932f0 build_engine.sh: just avoid passing CC, CXX and FTE_TARGET to the makelibs target of FTEQW to avoid headaches. Clearly makelibs doesn't handle any of this well without multiple passes. Just passing FTE_TARGET will sometimes not link libpng correctly? Someone else can study this if they like		2022-07-13 11:25:14 -07:00
base	Big commit fixing many regressions since crunch hit. env_sprite has been reworked.	2022-07-07 09:10:14 -07:00
doc	build.cfg: if BUILD_ENGINEREVISION is 0, build latest.	2021-08-27 12:31:07 +02:00
platform	Big commit fixing many regressions since crunch hit. env_sprite has been reworked.	2022-07-07 09:10:14 -07:00
src	NSRenderableEntity: add SetBoneControl methods.	2022-07-10 16:39:15 -07:00
.gitignore	Move game-specific sources into their respective mod-dirs. This was planned	2021-02-08 13:35:15 +01:00
LICENSE	Move doc/license to LICENSE for visibility	2021-03-09 10:36:33 +01:00
README.md	My name has changed, so an update to the copyright to reflect it.	2022-03-11 11:40:43 -08:00
build.cfg	Big commit fixing many regressions since crunch hit. env_sprite has been reworked.	2022-07-07 09:10:14 -07:00
build_all.sh	Switch from iqmtool to vvmtool.	2021-08-10 12:07:09 +02:00
build_editor.sh	Clean up some misc building stuff. Based on input by BartoCH, many thanks!	2022-06-06 19:58:29 -07:00
build_engine.sh	build_engine.sh: just avoid passing CC, CXX and FTE_TARGET to the makelibs target of FTEQW to avoid headaches. Clearly makelibs doesn't handle any of this well without multiple passes. Just passing FTE_TARGET will sometimes not link libpng correctly? Someone else can study this if they like	2022-07-13 11:25:14 -07:00
build_game.sh	build_game.sh: adjust set -e	2022-07-07 22:42:46 -07:00
build_tools.sh	Clean up some misc building stuff. Based on input by BartoCH, many thanks!	2022-06-06 19:58:29 -07:00
default.fmf	Menu-FN/FS: Only parse sprays from logos/, not root of mod-dir	2021-08-29 09:53:36 +02:00
get_gamepacks.sh	build.cfg: Add BUILD_UPDATE, which will control whether or not to run a vcs update command before building a project	2021-08-07 12:27:19 +02:00
make_dist.sh	make_dist.sh: bundle any script starting with install_*.sh into the game-dir	2021-08-29 16:03:48 +02:00
make_mapdef.sh	Clean-up defines for physics vars. Those are handled elsewhere...	2021-08-14 08:49:40 +02:00
make_shadertags.sh	Added make_shadertags.sh, which will prove useful for Radiant users	2021-08-16 10:48:01 +02:00
nuclide	nuclide.sh: Small tweak for compatibility	2022-04-24 15:20:04 -07:00
nuclide-ds	nuclide-ds: Don't specify -manifest any longer	2021-02-07 08:20:08 +01:00
vmap	TraceAttack: check surfaceflags on world traces, m_iMaterial on anything	2021-10-15 09:37:51 +02:00
worldspawn	Add VGUI_Active() which returns whether or not we're drawing VGUI elements,	2022-01-28 16:02:00 -08:00

README.md

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.

On Windows, please use cygwin for a sensible experience.

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.

Dependencies

Rough list of dependencies for the average Linux system. On some systems the names may slightly differ. These should be correct for OpenSUSE.

Engine

subversion
gmake
gcc
mesa-libGL-devel
libgnutls-devel
libopenal-devel
libX11-devel
libXcursor-devel
libXrandr-devel
libSDL2-devel (only if you pass BUILD_SDL2=1 to build_engine.sh)

For WinNT and Darwin systems it's recommended you use the SDL2 backend, but native backends may be available in FTEQW.

The X development packages are obviously only a requirement for when you do not compile an SDL2 build on a UNIX-like system.

FFMPEG Plugin

ffmpeg-4-libavformat-devel
ffmpeg-4-libswscale-devel

You want this plugin if you want playback of a variety of media formats, including video decoding.

Worldspawn Level Editor

gcc-c++
gtk2-devel
gtkglext-devel
libxml2-devel
libjpeg8-devel
minizip-devel

This is the only component that requires a C++ compiler.

Support

Join us in #nuclide on irc.libera.chat 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.

License

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.