nuclide/Documentation/ReadMe.md

# Overview

## Introduction

Welcome to the manual for **Nuclide**!

![](brick.png) This is a game development kit (GDK) and development environment for id Technology, using [FTE](https://www.fteqw.org/).
We are sharing it with the world in the hopes that it is useful!

![](book.png) [You can read more in-depth information, such as features here](About.md).

If you're looking for a similar project for vanilla id Tech 2 (Quake, QuakeWorld, HeXen II) then check out [Nuclide-Lite](https://code.idtech.space/vera/nuclide-lite).

## Learning Resources

![](hourglass.png) [Getting Started](GettingStarted.md)

![](table.png) [Guide To Decl Files](@ref decl)

![](table_edit.png) [Creating Weapons](@ref ncWeapon)

![](table_edit.png) [Creating Items](@ref ncItem)

![](page_code.png) [Writing Game Rules](@ref ncGameRules)


## Contributing

![](bug.png) You can contribute by filing bugs [here](https://www.github.com/veravisions/nuclide).
Overhaul of the entire documentation. 2022-10-03 00:10:54 +00:00			`# Overview`

The mother of experimental commits. 2024-06-22 07:24:13 +00:00			`## Introduction`
Overhaul of the entire documentation. 2022-10-03 00:10:54 +00:00
The mother of experimental commits. 2024-06-22 07:24:13 +00:00			`Welcome to the manual for Nuclide!`
Overhaul of the entire documentation. 2022-10-03 00:10:54 +00:00
Base: Give some love to base/ VGUI-Menu: friendList, chat backend, textview class proto SurfaceProps: Flesh impacts recognition PropData: BreakModels now use a bodyque to limit possible physics overhead PMove: falldamage, liquids can now be configured via external decl NSWeapon: added alternative punchangle based on springs, 'punchSpring X Y Z' in decl API: Team class management APIS NSPhysicsEntity: Optimised, optimised, optimised. New cvar: phys_lowspec. Scraping, impact effects etc have been added. More polish everywhere else 2024-12-05 03:04:56 +00:00			`![](brick.png) This is a game development kit (GDK) and development environment for id Technology, using [FTE](https://www.fteqw.org/).`
			`We are sharing it with the world in the hopes that it is useful!`
The mother of experimental commits. 2024-06-22 07:24:13 +00:00
Base: Give some love to base/ VGUI-Menu: friendList, chat backend, textview class proto SurfaceProps: Flesh impacts recognition PropData: BreakModels now use a bodyque to limit possible physics overhead PMove: falldamage, liquids can now be configured via external decl NSWeapon: added alternative punchangle based on springs, 'punchSpring X Y Z' in decl API: Team class management APIS NSPhysicsEntity: Optimised, optimised, optimised. New cvar: phys_lowspec. Scraping, impact effects etc have been added. More polish everywhere else 2024-12-05 03:04:56 +00:00			`![](book.png) [You can read more in-depth information, such as features here](About.md).`
Overhaul of the entire documentation. 2022-10-03 00:10:54 +00:00
unbreak against latest fteqcc 2025-02-01 00:08:38 +00:00			`If you're looking for a similar project for vanilla id Tech 2 (Quake, QuakeWorld, HeXen II) then check out [Nuclide-Lite](https://code.idtech.space/vera/nuclide-lite).`

multiprogs additions, decl integration, more of everything really 2024-10-17 05:52:27 +00:00			`## Learning Resources`
NSMoverEntity: call MoverStartsMoving() and MoverFinishesMoving() around arrival callbacks for entities that don't travel any distance. Fixing func_button entities from not toggling frames. 2023-03-22 07:22:47 +00:00
multiprogs additions, decl integration, more of everything really 2024-10-17 05:52:27 +00:00			`![](hourglass.png) [Getting Started](GettingStarted.md)`
Documentation improvements, cleaning up of misc files. 2024-01-02 05:20:02 +00:00
multiprogs additions, decl integration, more of everything really 2024-10-17 05:52:27 +00:00			`![](table.png) [Guide To Decl Files](@ref decl)`
Overhaul of the entire documentation. 2022-10-03 00:10:54 +00:00
Base: Give some love to base/ VGUI-Menu: friendList, chat backend, textview class proto SurfaceProps: Flesh impacts recognition PropData: BreakModels now use a bodyque to limit possible physics overhead PMove: falldamage, liquids can now be configured via external decl NSWeapon: added alternative punchangle based on springs, 'punchSpring X Y Z' in decl API: Team class management APIS NSPhysicsEntity: Optimised, optimised, optimised. New cvar: phys_lowspec. Scraping, impact effects etc have been added. More polish everywhere else 2024-12-05 03:04:56 +00:00			`![](table_edit.png) [Creating Weapons](@ref ncWeapon)`
The mother of experimental commits. 2024-06-22 07:24:13 +00:00
Base: Give some love to base/ VGUI-Menu: friendList, chat backend, textview class proto SurfaceProps: Flesh impacts recognition PropData: BreakModels now use a bodyque to limit possible physics overhead PMove: falldamage, liquids can now be configured via external decl NSWeapon: added alternative punchangle based on springs, 'punchSpring X Y Z' in decl API: Team class management APIS NSPhysicsEntity: Optimised, optimised, optimised. New cvar: phys_lowspec. Scraping, impact effects etc have been added. More polish everywhere else 2024-12-05 03:04:56 +00:00			`![](table_edit.png) [Creating Items](@ref ncItem)`
NSMoverEntity: call MoverStartsMoving() and MoverFinishesMoving() around arrival callbacks for entities that don't travel any distance. Fixing func_button entities from not toggling frames. 2023-03-22 07:22:47 +00:00
Base: Give some love to base/ VGUI-Menu: friendList, chat backend, textview class proto SurfaceProps: Flesh impacts recognition PropData: BreakModels now use a bodyque to limit possible physics overhead PMove: falldamage, liquids can now be configured via external decl NSWeapon: added alternative punchangle based on springs, 'punchSpring X Y Z' in decl API: Team class management APIS NSPhysicsEntity: Optimised, optimised, optimised. New cvar: phys_lowspec. Scraping, impact effects etc have been added. More polish everywhere else 2024-12-05 03:04:56 +00:00			`![](page_code.png) [Writing Game Rules](@ref ncGameRules)`
NSMoverEntity: call MoverStartsMoving() and MoverFinishesMoving() around arrival callbacks for entities that don't travel any distance. Fixing func_button entities from not toggling frames. 2023-03-22 07:22:47 +00:00
Overhaul of the entire documentation. 2022-10-03 00:10:54 +00:00
multiprogs additions, decl integration, more of everything really 2024-10-17 05:52:27 +00:00			`## Contributing`
Overhaul of the entire documentation. 2022-10-03 00:10:54 +00:00
multiprogs additions, decl integration, more of everything really 2024-10-17 05:52:27 +00:00			`![](bug.png) You can contribute by filing bugs [here](https://www.github.com/veravisions/nuclide).`