q3dominion v1.2.1

DOMINION

Random-data generating Algorithm for experimental Quake III Machinima purposes.

DOMINION is an algorithm written in JavaScript that generates random data for the production of experimental, depthmap-based Quake III Machinima. The algorithm outputs a list of various elements that correspond to Quake III Machinima-making processes and certain parameters found in Q3MME. Technically speaking, DOMINION is able to generate endless variations of potential experimental machinima films. DOMINION is able to generate and output data for the following elements:

• Runtime: The total length of your film in seconds;
• Amount of Maps: The total amount of Quake III Arena maps required for your film;
• Custom Map Input: Four randomly generated 'pseudo-words' per map as inspiration if you prefer to create custom maps for your project;
• LVLWorld Map ID Input: Randomized LVLWorld Map ID per map if you want to use existing maps for your film;
• Shot Amount: The amount of shots that need to be made per map;
• Shot Length: The length of each of your shots;
• Shot Content: Outputs various Q3MME parameters per shot, such as camera position, roll, yaw, FOV. In tandem, the Shot Content Definer also decides if shots contain camera animations, and if they do, what the animation parameters are;
• DepthMap Parameters: Generates four different depthmap profiles based on the mme_depthfocus and mme_depthrange parameters found in Q3MME for every single shot;
• Post-Production Flow: Generates a full edit list containing the required shots, their corresponding depthmap version, and length. Includes an automatic function that deletes excess frames if the output is over the runtime limit;

How To Use

• Install with npm i q3dominion.
• Import DOMINION into your project. For example with: const dominion = require('q3dominion').
• Create a function call with the dominion(); function.
• Initiate the call by typing node [yourprojectname.js]
• The algorithm should now output data in the terminal. If it doesn't, please check out the Documentation for troubleshooting.
• Once output has been completed, a .txt file containing a copy of your generated data will be automatically created in q3dominion/output as a tangible copy for later use.

Terms of Use

The DOMINION algorithm and its source code is licensed under the following MIT-License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this 
software and associated documentation files (hereafter referred to as the "Software"),
to deal in the Software without restriction, including without limitation the rights 
to use, copy, modify, merge, publish, distribute, sublicense and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so, 
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies 
or substantial portions of the Sofware. The above copyright holder shall be explicitly 
noted and included in all copies and substantial portions of the Software.

The software is provided 'as-is', without warranty of any kind, express or implied, 
including but not limited to the warranties of the merchantability, fitness for a 
particular purpose and noninfringement. In no event shall the author or copyright 
holders be liable for any claim, damages or other liability, whether in an action 
or contract, tort or otherwise, arising from, out of or in connection with the 
software or the use or other dealings in the software.