franciscodev / letters-soup

¡¡ Letters-soup!! 🍲

Descripcion

Letters-soup es una pequeña librería para crear tableros para jugar a encontrar la palabra.

[Y][O][T][K][L][M][C][M][O][N][G][K][O][H][V][A]
[H][R][Z][D][L][N][A][F][C][O][O][B][O][M][Y][B]
[Z][N][V][I][Y][T][A][Q][O][I][F][E][Y][U][C][E]
[K][X][O][U][K][V][V][Y][Z][T][L][U][L][T][I][J]
[Q][B][V][A][I][X][W][G][I][Y][A][A][X][G][R][A]
[M][V][R][A][P][E][R][I][C][O][X][G][W][X][A][F]
[Z][N][E][R][G][P][E][R][R][O][D][O][X][W][R][E]
[I][O][U][E][O][L][I][R][D][O][C][O][C][I][B][S]
[V][T][C][T][C][W][D][T][R][L][O][B][G][G][E][S]
[Y][A][K][N][N][A][X][T][L][C][E][Z][W][U][Z][L]
[J][R][A][A][C][T][N][W][X][B][R][Z][H][A][M][L]
[N][K][F][P][Y][H][N][G][P][L][G][S][Q][L][M][J]
[D][E][L][F][I][N][Y][C][U][U][I][B][Y][A][O][Z]
[B][F][L][Q][E][P][B][W][Q][R][T][O][N][O][M][G]
[A][T][A][M][A][L][O][N][H][R][O][V][M][Q][S][Y]
[Q][P][B][H][Y][H][O][G][E][P][Q][U][G][S][V][V]

Instalación

npm i letters-soup

Uso

El objeto Soup,recibe dos parámetros que son requeridos:

• data : array de string.
• size : un entero positivo que define el tamaño del tablero.

const data = ["iguala","cuervo","perro","cocodrilo","delfin"
                    ,"leon","pantera","gato","perico","mono"
                    ,"raton","abeja","zebra","tigre","canguro"];
const size = 10;
var soup =  new Soup(data,size);

⚠️ Tamaño de las palabras: Las palabras deben tener una longitud variable y menor al tamaño del tablero, ya que podría quedarse en un ciclo infinito tratando de colocar las palabras en el tablero; de igual forma el número de palabras debe ser proporcional al tamaño del tablero para que tengan una correcta distribución en el tablero.

Generar el tablero

La función generate# retorna un array con las palabras ingresadas, colocadas aleatoriamente.

var soup =  new Soup(data,size);
var board = soup.generate();

La función getSolution# retorna un array con la posición de las palabras ingresadas en el tablero .

ℹ️ Parámetro opcional: si se le pasa a la función cualquier palabra ingresada en el tablero retornara solo las posiciones de esa palabra de lo contrario devolverá todas las posiciones para todas las palabras ingresadas en el tablero.

var soup  =  new Soup(data,size);
//without param
var solve = soup.getSolution();
//with param
var solveToZebra = soup.getSolution('zebra');

La función setSize# establece un nuevo tamaño para el tablero recibe un valor numérico para el nuevo tamaño.

var soup  =  new Soup(data,size);
soup.setSize(10);

La función setContent# establece un nuevo contenido para el tablero recibe un array de string para colocar en el tablero.

ℹ️Contenido: el contenido no solo puede ser palabra también puede ser combinación de números, caracteres especiales etc. También se puede enviar un relleno acorde al contenido del tablero en la función setFill# para ocultar los caracteres.

const data = ["iguala","cuervo","perro","cocodrilo","delfin"
                    ,"leon","pantera","gato","perico","mono"]
//default fill is 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.            
var soup  = new Soup(data,size,fill);

const data2 = ["2343","4747","9699","2134","1241"
               ,"1111","0101","3435","5464","0909"];
var fill = "0123456789"; 
soup.setFill(fill);
soup.setContent(data2);

La función show# retorna un string con todas la posiciones del tablero.

var soup  = new Soup(data,size);
var board = soup.show();
console.log(board);

output:

[Y][O][T][K][L][M][C][M][O][N][G][K][O][H][V][A]
[H][R][Z][D][L][N][A][F][C][O][O][B][O][M][Y][B]
[Z][N][V][I][Y][T][A][Q][O][I][F][E][Y][U][C][E]
[K][X][O][U][K][V][V][Y][Z][T][L][U][L][T][I][J]
[Q][B][V][A][I][X][W][F][I][Y][A][A][X][G][R][A]
[M][V][R][A][P][E][R][I][C][O][X][G][W][X][A][F]
[Z][N][E][R][G][P][E][R][R][O][D][O][X][W][R][E]
[I][O][U][E][O][L][I][R][D][O][C][O][C][I][B][S]
[V][T][C][T][C][W][D][T][R][L][O][B][G][G][E][S]
[Y][A][K][N][N][A][X][T][L][C][E][Z][W][U][Z][L]
[J][R][A][A][C][T][N][W][X][B][R][Z][H][A][M][L]
[N][K][F][P][Y][H][N][G][P][L][G][S][Q][L][M][J]
[D][E][L][F][I][N][Y][C][U][U][I][B][Y][A][O][Z]
[B][F][L][Q][E][P][B][W][Q][R][T][O][N][O][M][G]
[A][T][A][M][A][L][O][N][H][R][O][V][M][Q][S][Y]
[Q][P][B][H][Y][H][O][G][E][P][Q][U][G][S][V][V]

La función setFill# establece un relleno para ocultar las palabras.

ℹ️ Relleno: por defecto el relleno es una cadena con todos los caracteres del abecedario 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' pero se puede utilizar cualquier cadena de caracteres acorde al contenido en el tablero.

const data = ["2343","4747","9699","2134","1241"
               ,"1111","0101","3435","5464","0909"];
var soup  = new Soup(data,size);
var fill = "0123456789"; 
soup.setFill(fill);

Full Ejemplo

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>
<body>
    <button onclick="solve()">solve</button>
    <button onclick="generate()">generate</button>
    <button onclick="setSize()">size</button>
    <script src="./soup.min.js"></script>
    <script>
      const data = ["iguala","cuervo","perro","cocodrilo","delfin"
                    ,"leon","pantera","gato","perico","mono"
                    ,"raton","abeja","zebra","tigre","canguro"];

      var soup = new  Soup(data,16);

      function generate() {
         soup.generate();
         console.log(s.show());
      }

      function solve() {
        console.log(soup.getSolution());
      }

      function setSize() {
        const data2 = ["iguala","cuervo","perro","cocodr","delfin"];
        soup.setContent(data2);
        soup.setSize(10);
      }

    </script>
</body>
</html>