Thanks to visit codestin.com
Credit goes to github.com

Skip to content

badele/neotex

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
LICENSE
LICENSE
 
 
README.md
README.md
 
 
logo.neo
logo.neo
 
 
logo.png
logo.png
 
 
logo.utf8.ans
logo.utf8.ans
 
 

Repository files navigation

neotex

Resurrecting 80s ANSI art into a clear, modern file format.

Neotex is a file format designed to make viewing and sharing ANSI art files (often encoded in CP437) easier. The concept is simple: separate the text content from the style sequences, allowing clean copy/paste of the text while preserving all formatting information.

Why Neotex?

  • Clean copy/paste: Raw text is directly readable and copyable
  • Human-readable format: Styles are expressed in a compact, readable format
  • Easy to parse: Simple line-by-line structure, ideal for implementation
  • Preserves ANSI art: All color and effect information is retained

Format Structure

Each line in a .neo file follows this structure:

<TEXT> | <METADATA_AND_STYLES>
  • Left part: The text content (Unicode characters)
  • Separator: The | (pipe) character
  • Right part: Metadata and style sequences

Simple Example

Hello World | 1:FR; 7:FG;

This line displays "Hello World" with:

  • Position 1: "Hello " in bright red (FR = Foreground Red bright)
  • Position 7: "World" in bright green (FG = Foreground Green bright)

Complete Specification

1. Metadata

Metadata starts with ! and appears at the beginning of the right part (typically on the first line, but can also be added on other lines).

Metadata Format Description
!V<n> !V1; Neotex format version
!TW<t>/<m> !TW80/120; Width: t = trimmed width, m = max width
!NL<n> !NL25; Total number of lines

Example:

Hello | !V1; !TW80/80; !NL10; 1:FR;

2. Style Sequences

General format of a sequence:

<POSITION>:<STYLE1>, <STYLE2>, ...;
  • POSITION: Character index (1-based) where the style applies
  • STYLES: List of style codes separated by commas
  • Each sequence ends with ;

3. Color Codes

ANSI 16 Colors

Normal Code Color Bright Code Color (bright)
Fk Black FK Bright Black (Gray)
Fr Red FR Bright Red
Fg Green FG Bright Green
Fy Yellow FY Bright Yellow
Fb Blue FB Bright Blue
Fm Magenta FM Bright Magenta
Fc Cyan FC Bright Cyan
Fw White FW Bright White
FD Default

Foreground (text): Prefix F Background: Prefix B

Color Code Description
Bk Background Black
Br Background Red
Bg Background Green
By Background Yellow
Bb Background Blue
Bm Background Magenta
Bc Background Cyan
Bw Background White
BD Background Default

Note: Background colors do not have bright variants (uppercase). The "bright" effect is achieved through letter case for foreground only.

256 Colors (Indexed Palette)

F<index>   Foreground indexed (0-255)
B<index>   Background indexed (0-255)

Examples:

  • F123: Foreground color index 123
  • B200: Background color index 200

RGB Colors (True Color)

F<RRGGBB>   Foreground RGB (hex)
B<RRGGBB>   Background RGB (hex)

Examples:

  • FFF0080: Foreground RGB(255, 0, 128) - pink
  • B00FF00: Background RGB(0, 255, 0) - green

4. Effect Codes

Code Effect Code Deactivation
EM Dim Em Dim OFF
EI Italic Ei Italic OFF
EU Underline Eu Underline OFF
EB Blink Eb Blink OFF
ER Reverse Er Reverse OFF

Note: There is no Bold effect. The "bright" version of a color (uppercase) replaces this effect.

5. Special Code

Code Description
R0 Full reset (resets all styles to default)

Formal Grammar (BNF)

<line>        ::= <text> " | " <right_part>
<right_part>  ::= <metadata>* <sequence>*

<metadata>    ::= "!" <meta_type> ";"
<meta_type>   ::= "V" <number>
                | "TW" <number> "/" <number>
                | "NL" <number>

<sequence>    ::= <position> ":" <styles> ";"
<position>    ::= <number>
<styles>      ::= <style> ("," <style>)*

<style>       ::= <color> | <effect> | "R0"
<color>       ::= <fg_color> | <bg_color>
<fg_color>    ::= "F" <color_value>
<bg_color>    ::= "B" <color_value>
<color_value> ::= <ansi_color> | <indexed> | <rgb>
<ansi_color>  ::= "k" | "K" | "r" | "R" | "g" | "G" | "y" | "Y"
                | "b" | "B" | "m" | "M" | "c" | "C" | "w" | "W" | "D"
<indexed>     ::= <digit> <digit>? <digit>?   ; 0-255
<rgb>         ::= <hex><hex><hex><hex><hex><hex>   ; RRGGBB

<effect>      ::= "E" <effect_char>
<effect_char> ::= "M" | "m" | "I" | "i" | "U" | "u" | "B" | "b" | "R" | "r"

<number>      ::= <digit>+
<digit>       ::= "0" | "1" | ... | "9"
<hex>         ::= <digit> | "A" | "B" | "C" | "D" | "E" | "F"
                         | "a" | "b" | "c" | "d" | "e" | "f"

Parsing Algorithm

Here are the steps to implement a Neotex reader:

1. For each line in the file:
   a. Split the line at " | " (positioned at !TW)
      - Left = text
      - Right = metadata + styles

   b. Parse the right part:
      - Split by ";"
      - For each segment:
        - If starts with "!" -> metadata
        - Otherwise -> style sequence

   c. For each style sequence:
      - Split by ":"
      - Left = position (integer)
      - Right = list of styles (split by ",")

   d. For each style:
      - Trim whitespace
      - Identify the type (color, effect, reset)
      - Apply the style starting from the position

Annotated Complete Example

Hello  | !V1; !TW6/80; !NL1; 1:FR, Bg; 4:R0; 6:FG;

Parsing:

  1. Text: Hello

  2. Metadata:

    • !V1: Version 1
    • !TW6/80: 6 characters wide from an initial 80 character width
    • !NL1: 1 line

  3. Styles:

    • Position 1: FR (bright red), Bg (green background)
    • Position 4: R0 (reset)
    • Position 6: FG (bright green)

Rendering:

  • Hel: Bright red on green background
  • lo: Default colors
  • `` (space after "Hello"): Bright green

Real Example: The Neotex Logo

Here is the content of the logo.neo file that generates the logo above:

▀▄          █▀▀▀▀█ ▐▀▀▀▀▀▀▀▀▀▀▀▀█      ▀▀▀▀▀▀▀▀▀▀     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ ▐▀▀▀▀▀▀▀▀▀▀▀▀█ ▐▀▀▀▀█     █▀▀▀▀█   | !V1; !TW104/104; !NL12; 1:FM, Bk; 3:R0; 13:FM; 14:Bm; 18:Bk; 21:Bm; 33:Bk; 35:R0; 40:FM; 50:R0; 55:FM; 72:Bm; 84:Bk; 87:Bm; 91:Bk; 92:R0; 97:FM; 98:Bm; 102:Bk; 104:R0
▄ ▀▄        ██████ ▐ ████████████   ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ ▐ ████████████ ▐ ████     █ ████   | 1:FM; 2:R0; 3:FM; 5:R0; 13:FM; 14:R0, Fg, Bk; 15:FM; 21:Bm; 22:Bk; 35:R0; 37:FM; 53:R0; 55:FM; 72:Bm; 73:Bk; 87:Bm; 88:Bk; 92:R0; 97:FM; 98:Bm; 99:Bk; 104:R0
 ▀▄ ▀▄      ██████ ▐ ████▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀ ▐ ████▀▀▀▀▀▀▀▀ ▐ ████     █ ████   | 2:FM; 4:R0; 5:FM; 7:R0; 13:FM; 14:R0, Fg, Bk; 15:FM; 21:Bm; 22:Bk; 35:R0; 36:FM; 72:Bm; 73:Bk; 87:Bm; 88:Bk; 92:R0; 97:FM; 98:Bm; 99:Bk; 104:R0
▀▄ ▀▄ ▀▄    ██████ ▐ ████▄▄▄▄▄▄▄▄ ▐█▀▀▀▀█▀ ▀▀ ▀██████ ▀▀▀▀ █▀▀▀▀█ ▀▀▀ ▐ ████▄▄▄▄▄▄▄▄ ▐██████▄▄▄█▀▄███▌   | 1:FM; 3:R0; 4:FM; 6:R0; 7:FM; 9:R0; 13:FM; 14:R0, Fg, Bk; 15:FM; 21:Bm; 22:Bk; 37:Bm; 41:Bk; 43:R0; 44:FK; 46:R0; 47:FM; 55:FK; 59:R0; 60:FM; 61:Bm; 65:Bk; 66:R0; 67:FK; 71:FM; 72:Bm; 73:Bk; 97:Bm; 99:Bk; 104:R0
  ▀▄ ▀▄ ▀▄  █▄████ ▐ ████▄▄▄▄▄▄▄█ ▐█ ████      █ ████      █ ████     ▐ ████▄▄▄▄▄▄▄█  ▀█████▄▄▄▄████▀    | 3:FM; 5:R0; 6:FM; 8:R0; 9:FM; 11:R0; 13:FM; 14:Bm; 15:Bk; 21:Bm; 22:Bk; 25:Bm; 33:Bk; 37:Bm; 38:Bk; 42:R0; 48:FM; 49:Bm; 50:Bk; 55:R0; 60:FM; 61:Bm; 62:Bk; 66:R0; 71:FM; 72:Bm; 73:Bk; 76:Bm; 84:Bk; 86:R0; 87:FM; 91:Bm; 92:Bk; 93:Bm; 97:Bk; 102:R0
▐█▄ ▀▄ ▀▄ ▀▄ ▀████ ▐ ████████████ ▐█ ████      █ ████      █ ████     ▐ ████████████ ▀ ▄███████████▄ ▀   | 1:FM; 4:R0; 5:FM; 7:R0; 8:FM; 10:R0; 11:FM; 13:R0; 14:FM; 21:Bm; 22:Bk; 37:Bm; 38:Bk; 42:R0; 48:FM; 49:Bm; 50:Bk; 55:R0; 60:FM; 61:Bm; 62:Bk; 66:R0; 71:FM; 72:Bm; 73:Bk; 86:FK; 87:R0; 88:Fg; 89:FM; 100:R0, Fg, Bk; 101:R0; 102:FK; 104:R0
▐ ██▄ ▀▄ ▀▄ ▀▄ ▀██ ▐▄████         ▐█ ████▄    ▄█ ████      █ ████     ▐▄████          ▄████▀▀ ▀▀████▄▄   | 1:FM; 2:Bm; 3:Bk; 6:R0; 7:FM; 9:R0; 10:FM; 12:R0; 13:FM; 15:R0; 16:FM; 21:Bm; 22:Bk; 26:R0; 35:FM; 37:Bm; 38:Bk; 43:R0; 47:FM; 49:Bm; 50:Bk; 55:R0; 60:FM; 61:Bm; 62:Bk; 66:R0; 71:FM; 72:Bm; 73:Bk; 77:R0; 87:FM, Bm; 88:Bk; 92:Bm; 93:R0, Fg, Bk; 94:R0; 95:FM; 96:Bm; 97:Bk; 101:Bm; 102:R0, Fg, Bk; 104:R0
▐ ████  ▀▄ ▀▄ ▀▄ ▀ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄  █▄▀█████████▄█████      █ ████     ▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄  ▀▄  █████   | 1:FM; 2:Bm; 3:Bk; 7:R0; 9:FM; 11:R0; 12:FM; 14:R0; 15:FM; 17:R0; 18:FM; 35:R0; 36:FM; 37:Bm; 39:Bk; 46:Bm; 49:Bk; 55:R0; 60:FM; 61:Bm; 62:Bk; 66:R0; 71:FM; 92:R0; 94:FK; 96:R0; 97:FM, Bm; 98:Bk; 104:R0
▐ ████ ▀▄ ▀▄ ▀▄ ▀▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄   ▀█▄▀▀██████████▀       █ ████     ▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄   █ ▄▄▄▄▄▄   | 1:FM; 2:Bm; 3:Bk; 7:R0; 8:FK; 10:R0; 11:FM; 13:R0; 14:FM; 16:R0; 17:FM; 35:R0; 37:FM; 39:Bm; 42:Bk; 47:Bm; 48:Bk; 53:R0; 60:FM; 61:Bm; 62:Bk; 66:R0; 71:FM; 92:R0; 95:FK; 96:R0; 97:FM; 104:R0
▐▄████   ▀▄ ▀▄ █ █ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄  ▀▄ ▀▀████████▀▀ ▄▀      █▄████     ▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄   █ ▄▄▄▄▄▄   | 1:FM; 2:Bm; 3:Bk; 7:R0; 10:FK; 12:R0; 13:FM; 15:R0; 16:FM; 17:R0; 18:FM; 35:R0; 36:FK; 38:R0; 39:FM; 51:R0; 52:FK; 55:R0; 60:FM; 61:Bm; 62:Bk; 66:R0; 71:FM; 92:R0; 95:FK; 96:R0; 97:FM; 104:R0
▄▄▄▄▄▄     ▀▄▄ ▄ ▄ ▄▄▄▄▄▄▄▄▄▄▄▄▄▄    ▀▀▄▄▄▄▄▄▄▄▄▄▀▀        ▄▄▄▄▄▄     ▄▄▄▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄   █▄▄▄▄▄▄▄   | 1:FK; 7:R0; 12:FK; 15:R0; 16:FK; 17:R0; 18:FK; 19:R0; 20:FK; 34:R0; 38:FK; 52:R0; 60:FK; 66:R0; 71:FK; 85:R0; 86:FK; 92:R0; 95:FK; 103:R0

This example shows:

  • Metadata on the first line: !V1; !TW104/104; !NL12;
  • Extensive use of FM (bright magenta) and Bm (magenta background) to create the gradient effect
  • R0 resets to return to default colors between colored zones

Projects Using Neotex

  • splitans - Parses ANSI/ASCII files and separates text from CSI sequences

Resources

ANSI/VT Documentation

Tools

About

Resurrecting 80s ANSI into a clear, modern file format.

Topics

bbs demoscene retro ansi file-format standard ascii-art bnf retrocomputing vt100 16colors

Resources

Readme

License

GPL-3.0 license
Activity

Stars

2 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published