Skip to content

Specifications

Nousad edited this page Aug 25, 2024 · 3 revisions

NS-DOS Specifications

⇒ Home

Specification Version Code Name Link
Nousad Image 1.0 Poplar Orchid
Nousad Session 1.0 Poplar
Nousad Filesystem 1.0 Orchid

Nousad Image (NSIMG)

Specification

Specification Version 1.0

〕 The file extension can be either .json or custom extensions .nsimg or .nousadimg.

Structure

{
    "type": "NS-IMAGE",
    "version": "1.0",
    { "NS-SESSION" },
    { "NS-FILESYSTEM" },
}
Value Type Description
type string Type of image.
version string Version of image.
NS-SESSION object Session object.
NS-FILESYSTEM object Filesystem object.

Changelog

[1.0] Poplar Orchid ‒ 25.08.2024

Added

  • Structure
    • Type Field
    • Version Field
    • Session Object
    • Filesystem Object

Updated

Removed




Nousad Session (NSS)

Specification

Specification Version 1.0

〕 The file extension can be either .json or custom extensions .nss or .nousads.

Structure

{
    "type": "NS-SESSION",
    "version": "1.0",
    "parameters": {
        "console": {
            "background": "black",
            "foreground": "white",
            "codePage": "437",
        },
        "bootScreen": {
            "image": "",
        },
    },
}
Value Type Description
type string Type of file system.
version string Version of file system.
parameters object Session parameters.
  • Parameters
Value Type Description
console object Console parameters.
bootScreen object Boot screen parameters.
  • Parameters > Console
Value Type Description
background string Background color.
foreground string Foreground color.
codePage string Code Page / Localization
  • Parameters > Boot Screen
Value Type Description
image string Source for boot image.

Changelog

[1.0] Poplar ‒ 25.08.2024

Added

  • Structure

    • Type Field
    • Version Field
    • Parameters Object
  • Parameters

    • Console Object
    • Boot Screen Object
  • Console Parameters

    • Background Object
    • Foreground Object
    • Codepage Object
  • Boot Screen Parameters

    • Image Object

Updated

Removed




Nousad Filesystem (NSFS)

Specification

Specification Version 1.0

〕 The file extension can be either .json or custom extensions .nsfs or .nousadfs.

Structure

{
    "type": "NS-FILESYSTEM",
    "version": "1.0",
    "drives": [
        {
            "type": "drive",
            "headers": {
                "name": "<LETTER OF DRIVE>",
                "modified": "1970-01-01T00:00:00Z",
            },
            "content": [
                {
                    "type": "directory",
                    "headers": {
                        "name": "<directory name>",
                        "created": "1970-01-01T00:00:00Z",
                        "modified": "1970-01-01T00:00:00Z",
                        "read_only": false,
                        "hidden": false,
                        "system": false,
                        "encode": false,
                    },
                    "content": [
                        {
                            "type": "file",
                            "headers": {
                                "name": "<file name>",
                                "extension": "<file extension>",
                                "filetype": "<file extension in mimetype>",
                                "created": "1970-01-01T00:00:00Z",
                                "modified": "1970-01-01T00:00:00Z",
                                "read_only": false,
                                "hidden": false,
                                "system": false,
                                "encode": false,
                            },
                            "content": "",
                        }
                    ],
                }
            ],
        }
    ],
}
Value Type Description
type string Type of file system.
version string Version of file system.
drives array Array of connected drives.
  • Drives
Value Type Description
type string Type of entity. (in this case drive)
headers object Headers of entity.
content array Array of content.
  • Drives > Headers
Header Type Description
name string Name of drive.
modified datatime When drive was last modified.
  • Directories
Value Type Description
type string Type of entity. (in this case directory)
headers object Headers of entity.
content array Array of content.
  • Directories > Headers
Header Type Description
name string Name of directory.
created datatime When directory was created.
modified datatime When directory was last modified.
read_only boolean Is directory read only.
hidden boolean Is directory hidden.
system boolean Is directory system. Systems directories cannot be deleted.
encode boolean Is directory encoded.
  • Files
Value Type Description
type string Type of entity. (in this case file)
headers object Headers of entity.
content array Array of content.
  • Files > Headers
Header Type Description
name string Name of file.
extension string Extension of file in “.<extension>” format.
filetype string Extension of file in mimetype.
created datatime When file was created.
modified datatime When file was last modified.
read_only boolean Is file read only.
hidden boolean Is file hidden.
system boolean Is file system. Systems files cannot be deleted.
encode boolean Is file encoded.

Changelog

[1.0] Orchid ‒ 25.08.2024

Added

  • Structure

    • Type Field
    • Version Field
    • Drives Array
  • Drive Structure

    • Type Field
    • Headers Object
      • Name Header
      • Modified Header
    • Content Array
  • Directory Structure

    • Type Field
    • Headers Object
      • Name Header
      • Created Header
      • Modified Header
      • Read_Only Header
      • Hidden Header
      • System Header
      • Encode Header
    • Content Array
  • File Structure

    • Type Field
    • Headers Object
      • Name Header
      • Extension Header
      • Filetype Header
      • Created Header
      • Modified Header
      • Read_Only Header
      • Hidden Header
      • System Header
      • Encode Header
    • Content Field

Updated

Removed




⇒ Home