<h1 id="data-types">Data Types<a aria-hidden="true" class="anchor-heading icon-link" href="#data-types"></a></h1>
<p>Data types are handled somewhat oddly by the game code written in QuakeC.  Since these values matter when entering numbers or text onto <code>key|value</code>s in a map editor, I am providing this for reference and to help avoid typical pitfalls. Please note that the Readme Data type is how the variable is intended to be used and now how it is actually handled by the code.  Most of these can have floating point values assigned to them, but the behavior is undefined and is not recommended.</p>
<div class="table-responsive">














































<table><thead><tr><th>Readme Data Type</th><th>QuakeC Type</th><th>Initial Value</th><th>Range/Values</th><th>Notes</th></tr></thead><tbody><tr><td>boolean</td><td>float</td><td>0</td><td>0,1</td><td>Only 0 is false, any other value, including negatives is true and treated as a value of 1 in QuakeC</td></tr><tr><td>trilean</td><td>float</td><td>0</td><td>-1,0,1</td><td>This is not technically a data type as far as the QC is concerned.  Merely an integer used like a 3 value variable as an aid to the mapper to force certain conditions by using -1.</td></tr><tr><td>integer</td><td>float</td><td>0</td><td>-8388608 to 8388608</td><td>Whole numbers used for countable quantities or for bitmasks.  Assigning a fractional value is possible, but would mess up the bits on a bit mask and might provide a wrong count, such as for <code>trigger_counter</code> which could break map progression.</td></tr><tr><td>float</td><td>float</td><td>0</td><td>-8388608.0 to 8388608.0</td><td>Numbers capable of having fractional portions after the decimal separator.  Technically should be able to go higher in maximum value using exponents, but QuakeC isn't exposed to the exponent portion of floats.</td></tr><tr><td>string</td><td>string</td><td>""</td><td>abc...123...etc.</td><td>These characters require backslashes before them: <code>\n</code> for newline, <code>\'</code> for single quote, <code>\b</code> for "bold" orange text.</td></tr></tbody></table></div>
<hr>
<strong>Backlinks</strong>
<ul>
<li><a href="/KeepModReadme/notes/aum55alyokbtaszwruzz064">Common Attributes</a></li>
</ul>

Data Types

KeepModReadme

Compiled and Edited by W. Josiah Jack, aka Qmaster.  Aug 23, 2008 to 2024.

#### Current Version: ![tag](https://img.shields.io/github/v/tag/JosiahJack/Keep?label=Latest%20Release)
#### Compiled and Edited by W. Josiah Jack, aka Qmaster.  Aug 23, 2008 to 2024.
`NOTE: This is a work in progress!  Expect updates!`

`NOTE: This is the manual.  For the actual mod see` [here](https://github.com/JosiahJack/Keep)

`NOTE: This manual is autogenerated by a Github Action from` [this repo](https://github.com/JosiahJack/KeepModReadme)

---

_One mod to rule them all_

_One mod to find them_

_One mod to Keep them all_

_and in Quake bind them_

-ijed

<br />

_You Keep what you kill...and kill with._

-Qmaster
<br />
<br />
<br />
Welcome weary traveler!  Within these dusty pages you may find a detailed technical explanation of what I have discovered and kept on my many travels in the land of Quake.

What started as an effort to add a few items from both mission packs into one single player level eventually grew over time to be a massive compilation of features from across the Quake community.
This mod for the first [Quake (1996)](https://quake.fandom.com/wiki/Quake) is primarily a full combination of the following mods’ enemies, weapons, items, traps, and other features in addition to
my own features:
* Standard Quake (ID1)........[[link](https://quake.fandom.com/wiki/Quake)]
* Mission Pack 1 (Hipnotic)...[[link](https://quake.fandom.com/wiki/Quake_Mission_Pack_1:_Scourge_of_Armagon)]
* Mission Pack 2 (Rogue)......[[link](https://quake.fandom.com/wiki/Quake_Mission_Pack_2:_Dissolution_of_Eternity)]
* Arcane Dimensions (AD) [[link](http://www.simonoc.com/pages/design/sp/ad.htm)] [[mirror](https://www.quaddicted.com/reviews/ad_v1_80p1final.html)]
* Drake (SOE, etc.) [[link](https://www.quaddicted.com/reviews/something_wicked.html)]
* Quoth [[quoth 1](https://www.quaddicted.com/webarchive/kell.quaddicted.com/) [[quoth 2.2](https://tomeofpreach.wordpress.com/quoth/)]
* Kinn (Marcher, etc.) [[marcher](https://www.quaddicted.com/reviews/kinn_marcher.html) [[bastion](https://www.quaddicted.com/reviews/kinn_bastion.html)]
* Custents [[link](https://www.quakewiki.net/quake-1/mods/custents-custom-entities/)]
* extras_r5 [[link](https://github.com/khreathor/extras_r5)] [[extras_r4 (older)](https://www.quakewiki.net/quake-1/mods/extras-r4/)] [[docs](http://khreathor.xyz/jam/extras/index.html)]
* Nehahra [[link](https://www.quaddicted.com/reviews/nehahra.html)]
* Rubicon and Rubicon 2 [[rubicon](https://www.quaddicted.com/reviews/rubicon.html)] [[rubicon2](https://www.quaddicted.com/reviews/rubicon2.html)] [[rrp](https://www.quaddicted.com/reviews/rrp.html)]
* Other various community contributions, refer to the Credits


Arcane Dimensions serves as the primary base for all added content due to its excellent formatting, enhanced enemy infighting code, and excellent structure.

Any conflicts have been resolved in such a manner as to retain the unique features of the primary mods above, for instance by using spawnflags, such that any mod's conflicting variant is avaialable.
The entity definition file (.fgd) contains all the necessary fields and spawnflags for accessing these conflict resolving features as well as any Keep specific features that have been added.

All features of this mod are documented here in their various sections.  A complete entity list can be found in the appendix.  In every section the entities are listed alphabetically by entity name.

For what is and isn't implemented, refer to the [Checklist](https://github.com/JosiahJack/Keep/blob/master/KeepFeatureChecklist.xlsx)

# Motivation

The purpose of this mod is to provide a toolset for creating any kind of Quake
map you desire with anything you may have encountered in some of the best known
mods.  This mod is a mod for mappers, intended for mappers to make excellent
maps for players to play.  Also, in the spirit of the earliest days of Quake,
this mod is not striving for overall quality, nor quantity, but is intending to
provide fun.  Some content is intentionally as-is, in terms of quality, to
preserve the old-school 90's feel; other content is much more polished.  The
quality of content you use is up to you, the mapper.

> The mapper is always right.  The player is at the mercy of the mapper.

# TABLE OF CONTENTS
Here are links to each book within the tome.

* [[general]]
* [[credits]]
* [[enemies]]
* [[weapons]]
* [[items]]
* [[traps]]
* [[brush-entities]]
* [[point-entities]]
* [[requirements]]


.

.

.

DISCLAIMERS:
The contents herein may have originally derived from other authors.  I make no claim that the full contents are an original work, rather only the compilation as such is original.  Please refer to the
Source Mod specified on each item's listing and refer to the credits folder for the original authors of some content.  Most content is GPL licensed since original Quake qc code and engine were
release under said grandfathering license that requires similar or stricter licensing for rerelease.

All content is provided as-is to be used at your own risk of fun or otherwise.

If you have found this in a far flung future, the language used here is English, specifically an ancient snapshot known as "Modern English" as defined by certain pompous people of the time period between the years AD1990 to AD2021.


Readme Data Type	QuakeC Type	Initial Value	Range/Values	Notes
boolean	float	0	0,1	Only 0 is false, any other value, including negatives is true and treated as a value of 1 in QuakeC
trilean	float	0	-1,0,1	This is not technically a data type as far as the QC is concerned. Merely an integer used like a 3 value variable as an aid to the mapper to force certain conditions by using -1.
integer	float	0	-8388608 to 8388608	Whole numbers used for countable quantities or for bitmasks. Assigning a fractional value is possible, but would mess up the bits on a bit mask and might provide a wrong count, such as for `trigger_counter` which could break map progression.
float	float	0	-8388608.0 to 8388608.0	Numbers capable of having fractional portions after the decimal separator. Technically should be able to go higher in maximum value using exponents, but QuakeC isn't exposed to the exponent portion of floats.
string	string	""	abc...123...etc.	These characters require backslashes before them: `\n` for newline, `\'` for single quote, `\b` for "bold" orange text.