FAQ For Programmers¶
This page will answer some common questions from programmers learning Denizen. These topics will not necessarily make much sense to those without a programming background.
Table of Contents
In terms of purely how it appears visually, Denizen often is said to be similar looking to Python.
In terms of logic, Denizen is very similar to Bash or other command-line scripting languages.
To understand why, it's important to know the basic categories of programming language syntax:
SomeFunction(arg1, arg2). Python is not "C Syntax", but is still functional syntax.
Various other core syntax categories exist (such as those used in LISP, Haskell, Ruby, etc.) exist but are unimportant to this point.
Command+Tag syntax is the syntax every sysadmin learns in one form or another. This syntax is characterized with a natural tendency to work well when typed into a command line, formed from a series of lines that have a command followed by a list of (usually space-separated) arguments, interpretting all input as raw values, but having some special character that means some subsection of the input is to be processed as some lookup call and the result replaces that spot. This is the syntax used by Bash, CommandPrompt, PowerShell (mostly), and of course... Denizen.
Consider for example, the Bash line
ls -la $FOLDER - this runs the command named
ls (list files) with the first argument being the raw text
-la (that will be interpretted as list style flags) and the second argument prefixed with the $ symbol indicating that it should be looked up from the environment variable list (presumably some variable containing a relevant folder path). The
$FOLDER input will be replaced with an actual path, and the executed command will end up like
ls -la mydir/.
Denizen fits this same basic syntax category... consider for example the Denizen line
narrate "hello there!" targets:<[players]> - this runs the command
narrate with the first argument being the raw text
hello there! (that will be interpretted as a message to show) and the second argument using
<> to indicate a tag lookup, and
 to indicate a definition lookup (presumably some list of players). The executed command end up like
- narrate "hello there!" targets:li@p@bob|p@joe.
Short answer: No.
Medium answer: Denizen is object-based, but not object-oriented-only.
Long answer: Denizen does not fit the category of 'purist OOP' (like Java) nor 'multi-paradigm but can be OOP' (like C#).
Denizen uses objects to represent all data, which makes it object-based. Denizen also allows you to define your own object types, but actively discourages doing so.
Denizen is designed to work with very terse quick lines (you can accomplish entire relatively complex goals in a script containing a single-digit number of lines, thanks to the numerous time-saver do-it-all utility commands available), and the naturally long-winded nature of OOP is inherently in opposition to this goal. Going to the trouble of rigidly defining custom object types simply doesn't carry much advantage in a language where most created methods/functions would be only 1 or 2 lines long anyway. In addition, defining long careful objects will cause you to write long, complicated scripts that, within the syntax of Denizen, will end up being much more confusing to follow than if you just wrote the imperative logic directly.
Denizen is 100% Free-and-Open-Source-Software (FOSS), under the MIT License.
We strongly believe that publishing the full readable, hackable, and buildable source for our work is inherently beneficial to the general good: It grants near-unlimited freedom to our users, it allows anyone with skill to contribute to making Denizen be the best it can be, and it ensures that the project will last and still be available to users even if something happens that disrupts the project's normal development (eg existing developers cease work on it, or if the project is taken over by anyone that wouldn't publish it under fair terms).
The Denizen implementation for Spigot is on GitHub here. The core code for Denizen is here. You can also find the source of this very guide here. You might also be interested in the meta-doc-helper-bot for Discord here or the VS Code extension here.
Sure! We've accepted a lot of pull requests from a variety of contributors over the years. We ask that you discuss what you intend to PR on the Discord before making it though, to avoid wasting your time on something that is already available, or just to make sure you know how to go about the specific task properly.
When you make a Pull Request, you will be automatically asked to accept a CLA that says you agree that your contributions are given fully to the Denizen project, and that you accept that you can never prevent or restrict usage of that contribution after it's been pulled. We have this in place to help ensure that Denizen always remains free and unrestricted for everyone.