Skip to content

glossary.md

Latest commit

 

History

History
310 lines (232 loc) · 9.83 KB

glossary.md

File metadata and controls

310 lines (232 loc) · 9.83 KB
Raw

Glossary - SDK Development Terminology

Essential terms for BlockCore-SDK development, explained for enterprise developers.

A

API (Application Programming Interface)

  • Definition: Interface between software components
  • SDK Context: Public interface for extending the engine
  • Enterprise Analogy: Like web APIs, but for game engine extensions

Argument

  • Definition: Command-line parameter passed to a program
  • SDK Context: Required or optional parameters for CLI commands
  • Enterprise Analogy: Like function parameters, but from command line

Assembly

  • Definition: Compiled .NET code unit
  • SDK Context: Plugin binary containing extension code
  • Enterprise Analogy: Like compiled libraries or executables

B

Builder Pattern

  • Definition: Design pattern for constructing complex objects
  • SDK Context: Building project configurations step by step
  • Enterprise Analogy: Like configuration builders in enterprise apps

Binary

  • Definition: Compiled executable or library file
  • SDK Context: Plugin or extension executable
  • Enterprise Analogy: Like compiled applications or libraries

C

CLI (Command Line Interface)

  • Definition: Text-based user interface
  • SDK Context: Command-line tools for developers
  • Enterprise Analogy: Like PowerShell scripts or batch files

Command

  • Definition: Action that can be executed from command line
  • SDK Context: SDK operations like create, validate, pack
  • Enterprise Analogy: Like API endpoints, but for command line

Component

  • Definition: Modular piece of functionality
  • SDK Context: Reusable parts of the SDK system
  • Enterprise Analogy: Like microservices or modules

D

Dependency

  • Definition: External requirement for a project
  • SDK Context: Required packages, libraries, or tools
  • Enterprise Analogy: Like NuGet packages or npm dependencies

Distribution

  • Definition: Package for sharing with others
  • SDK Context: ZIP file containing extension
  • Enterprise Analogy: Like software installers or packages

E

Extension

  • Definition: Additional functionality added to base system
  • SDK Context: Plugin, resource pack, or data pack
  • Enterprise Analogy: Like plugins or add-ons

Error Handling

  • Definition: Process of managing and reporting errors
  • SDK Context: Graceful failure and user-friendly error messages
  • Enterprise Analogy: Like exception handling in applications

F

Factory Pattern

  • Definition: Design pattern for creating objects
  • SDK Context: Creating different types of projects or components
  • Enterprise Analogy: Like object factories in enterprise applications

Framework

  • Definition: Reusable software platform
  • SDK Context: BlockCore engine framework
  • Enterprise Analogy: Like .NET Framework or Spring Framework

G

Generator

  • Definition: Tool that creates code or files automatically
  • SDK Context: Project scaffolding and template processing
  • Enterprise Analogy: Like code generators or scaffolding tools

Glob Pattern

  • Definition: Pattern matching for file paths
  • SDK Context: Selecting files for processing or packaging
  • Enterprise Analogy: Like regex patterns, but for file paths

H

Handlebars

  • Definition: Template engine for text processing
  • SDK Context: Processing project templates with variables
  • Enterprise Analogy: Like Razor templates or Mustache

Help System

  • Definition: Documentation and assistance for users
  • SDK Context: Command help, usage examples, error messages
  • Enterprise Analogy: Like help documentation or tooltips

I

Installation

  • Definition: Process of adding software to system
  • SDK Context: Installing extensions to local environment
  • Enterprise Analogy: Like software installation or deployment

Interface

  • Definition: Contract defining how components interact
  • SDK Context: Plugin interfaces and SDK APIs
  • Enterprise Analogy: Like service contracts or APIs

J

JSON Schema

  • Definition: Specification for validating JSON data
  • SDK Context: Validating project manifests and configurations
  • Enterprise Analogy: Like XML Schema or data validation rules

L

Library

  • Definition: Collection of reusable code
  • SDK Context: SDK libraries and engine dependencies
  • Enterprise Analogy: Like NuGet packages or shared libraries

Linting

  • Definition: Static analysis of code for errors
  • SDK Context: Checking code quality and style
  • Enterprise Analogy: Like code analysis tools

M

Manifest

  • Definition: File describing package contents and metadata
  • SDK Context: Project configuration and package information
  • Enterprise Analogy: Like package.json or project files

Metadata

  • Definition: Data describing other data
  • SDK Context: Project information, versions, dependencies
  • Enterprise Analogy: Like database schema or configuration

N

Namespace

  • Definition: Logical grouping of code elements
  • SDK Context: Organizing SDK classes and functions
  • Enterprise Analogy: Like package names or module organization

NuGet

  • Definition: Package manager for .NET
  • SDK Context: Managing SDK dependencies and packages
  • Enterprise Analogy: Like npm for Node.js or Maven for Java

O

Option

  • Definition: Command-line flag or parameter
  • SDK Context: CLI flags like --version, --help, --verbose
  • Enterprise Analogy: Like function parameters or configuration options

Output

  • Definition: Result produced by a program
  • SDK Context: Generated files, console messages, error reports
  • Enterprise Analogy: Like function return values or log output

P

Package

  • Definition: Bundled collection of files and metadata
  • SDK Context: Distributable extension archive
  • Enterprise Analogy: Like software packages or installers

Plugin

  • Definition: Software component that extends functionality
  • SDK Context: Engine extension adding new features
  • Enterprise Analogy: Like browser extensions or IDE plugins

Project

  • Definition: Collection of files and configuration
  • SDK Context: Extension development workspace
  • Enterprise Analogy: Like solution or workspace in IDEs

Q

Quality Assurance

  • Definition: Process of ensuring software quality
  • SDK Context: Testing and validating extensions
  • Enterprise Analogy: Like testing and code review processes

R

Repository

  • Definition: Storage location for code and files
  • SDK Context: Source code repository or package repository
  • Enterprise Analogy: Like Git repositories or package feeds

Resource

  • Definition: File or data used by application
  • SDK Context: Textures, sounds, models, scripts
  • Enterprise Analogy: Like assets or static files

S

Schema

  • Definition: Structure definition for data validation
  • SDK Context: JSON schemas for project validation
  • Enterprise Analogy: Like database schemas or data contracts

Scaffolding

  • Definition: Generating project structure from templates
  • SDK Context: Creating new projects with standard structure
  • Enterprise Analogy: Like project templates or code generators

SDK (Software Development Kit)

  • Definition: Collection of tools for developing software
  • SDK Context: BlockCore-SDK for engine extensions
  • Enterprise Analogy: Like development toolkits or frameworks

T

Template

  • Definition: Reusable pattern for creating content
  • SDK Context: Project templates and file templates
  • Enterprise Analogy: Like code templates or document templates

Toolchain

  • Definition: Set of tools used in development process
  • SDK Context: CLI tools, validators, packagers
  • Enterprise Analogy: Like build pipelines or development workflows

U

Uninstall

  • Definition: Process of removing software from system
  • SDK Context: Removing extensions from local environment
  • Enterprise Analogy: Like software uninstallation

User Experience (UX)

  • Definition: Overall experience of using a product
  • SDK Context: Developer experience with SDK tools
  • Enterprise Analogy: Like user interface design

V

Validation

  • Definition: Process of checking data correctness
  • SDK Context: Verifying project structure and content
  • Enterprise Analogy: Like data validation or input checking

Version

  • Definition: Specific release of software
  • SDK Context: SDK version, engine version, extension version
  • Enterprise Analogy: Like software versions or API versions

W

Workspace

  • Definition: Development environment and project files
  • SDK Context: Developer's working directory and configuration
  • Enterprise Analogy: Like development environment or project folder

X

XML

  • Definition: Extensible Markup Language
  • SDK Context: Configuration files and project metadata
  • Enterprise Analogy: Like configuration files or data exchange

Y

YAML

  • Definition: Human-readable data serialization format
  • SDK Context: Configuration files and project settings
  • Enterprise Analogy: Like JSON but more human-readable

Z

ZIP

  • Definition: Compressed archive format
  • SDK Context: Package distribution format
  • Enterprise Analogy: Like compressed files or archives

Common Acronyms

CLI: Command Line Interface SDK: Software Development Kit API: Application Programming Interface JSON: JavaScript Object Notation XML: Extensible Markup Language YAML: YAML Ain't Markup Language ZIP: ZIP Archive Format IDE: Integrated Development Environment UX: User Experience QA: Quality Assurance

Need more terms? Check the CLI Patterns for architectural concepts!