Skip to content

Latest commit

 

History

History
137 lines (112 loc) · 5.77 KB

README.md

File metadata and controls

137 lines (112 loc) · 5.77 KB
Raw

NodeToJS

NodeToJS is a module/library at once: a module for NodeJS and a library for Javascript (JS). It allows to create text based apps/games that can be executed and work both in the terminal (for Windows, Linux or Mac) and in a web browser. That is, create a terminal (CLI) app/game and a text-based webapp/webgame with the same code.

Features:

  • Use canvas to simulate the terminal.
  • Draw text with foreground color and background color.
  • Read key events.
  • It has no user text input fields (for now).

Use:

The minimum files you need are four:

  • A wrap file:                         app.html
  • A monospace font. I recommend woff files. For example:     WebPlus_ToshibaSat_9x16.woff
  • The NodeToJS module/library:                  NODEtoJS.js
  • Your main .js file.                       app.js

You can get old PC fonts here: https://int10h.org/oldschool-pc-fonts/fontlist/

Hello world example.

alt text

  1. Your HTML wrap file (for example app.html) will load the NodeToJS library (NodeToJS.js) and will load the starter NodeJS/Javascript script of yout app (app.js in this example). You also have to add NodeToJS.HTMLMODE=1 right after loading the library/module and before loading your scripts.

app.html

     <!DOCTYPE html><html><head><meta charset="utf-8"></head><body></body></html>
     <script src="NodeToJS.js"></script><script>NodeToJS.HTMLMODE=1</script>
     <script src="app.js"></script>
  1. Your apps.js. This file is an example to demonstrate the main functions of NodeToJS module/library.

app.js

     function readKey(){
          NodeToJS.readkey(function(k){ // k is the key pressed
                if(k=="x"){
                    NodeToJS.cleanScreen(0);
                    NodeToJS.draw([{c:1,b:7,y:1,x:1,t:" See you soon! "}])
                    NodeToJS.exit()
                }
          })
     }
     function init(){
          // NodeToJS.scaleFullScreen();
          NodeToJS.cleanScreen(16); // 16 is the background color used to clean the terminal
          NodeToJS.draw([
          // c is the foreground color, b is the background color, y and x are the terminal coordinates, t is the text to draw
                {c:0,b:17,y:5,x:10, t:"┌─────────────┐"},
                {y:6,x:10,          t:"│ Hello world │"},
                {y:7,x:10,          t:"└─────────────┘"},
                {c:7,b:6,y:9,x:8,t:" Press 'x' to exit "}
          ]);
          readKey();
     }
     if(typeof(NodeToJS)=="undefined"){NodeToJS=require('./NodeToJS.js').NodeToJS}
     NodeToJS.start(35,14,"./WebPlus_ToshibaSat_9x16.woff",9,16,function(){ 
          // 35 and 14 are the maximum columns and the rows of the simulated terminal
          // WebPlus_ToshibaSat_9x16.woff is a monospace font that my simulated terminal will use. 
          // 9 and 16 are the width and height of each character of the chosen font, measured in pixels.
          init()
     });
  1. How to run?
  • If you want to run it from terminal: node helloworld.js
  • If you want to run it from web browser: open helloworld.html

A more advanced example: bashBlitz.

To better demonstrate the usefulness of NodeToJS I have converted my bashBlitz game (https://github.com/diejuse/bashblitz) to NodeJS/Javascript using my module/library. This way you can play from the terminal (node bashblitz.js) or from a web browser (by opening bashblitz.html). You can play it here: https://mural.uv.es/diejuse/bashblitz/bashblitz.html

Click to view my Youtube video: Demo

Documentation.

Code of colors (foreground and background)

0: black      10: darkgray
1: red      11: lightred
2: yellow     12: lightyellow
3: green     13: lightgreen
4: blue      14: lightblue
5: purple     15: violet
6: niagara     16: cyan
7: lightgray     17: white

Functions

.start( term_columns, term_rows, font_url, width_fontpixels, height_fontpixels, success)

- term_columns: Number of columns of the simulated terminal.
- term_rows: Number of rows of the simulated terminal.
- font_url: A string containing the URL to load the the monospace choosen font. https://int10h.org/oldschool-pc-fonts/download/oldschool_pc_font_pack_v2.2_web.zip
- width_fontpixels: Width of the loaded text font, measured in number of pixels.
- height_fontpixels: Height of the loaded text font, measured in number of pixels.

.draw( list_to_draw )

- list_to_draw: Array of elements to draw on the pseudo terminal with this structure:
{c:foreground color code, b: background color code, x: x-coordinate of the pseudo terminal, y: y-coordinate of the pseudo terminal, t: text to draw}

.cleanScreen(bgcolor)

- bgcolor: Background color code to clean the pseudo terminal.

.getColumns()

Get the number of columns of the real terminal.

.getRows()

Get the number of rows of the real terminal.

.scaleFullscreen()

It allows to scale the pseudo terminal to the size of the entire body of the web window.

.readkey(function(k){ .... })

k: It's the key pressed to detect.

.exit()

End the application.