Giter VIP home page Giter VIP logo

word-search-game's Introduction

Word Search Game

Simple application to create and print your word search games using Yaml files.

Installation

npm

npm install word-search-game -g

Yarn

yarn global add word-search-game

Getting Started

  • Create a Yaml file

Yaml files need to follow this structure:

title: Any title
words:
    - Word1
    - Word2
    - Word3
    - ...
  • Open a terminal in the same Yaml directory.
  • Call word-search-game, you will get a prompt of Yaml files that reside in the current directory.
  • Select your file and wait till generation completes, after that it will open a browser with the game ready to be printed.
  • A generated folder will be created with the word games with .html format.

Another ways to call a Yaml file:

File in current directory

word-search-game example.yml

File in a relative path

word-search-game some-path/example.yml

In this case, generated folder will be created under some-path

That's it!

I highly recommend to create up to 15 words. This will fit perfectly in a letter sheet in landscape mode.

How it works?

This application is a wrapper of this webpage. Config like number of rows and columns can be set at ./lib/default-form-data.js.

Examples

From this Yaml file:

title: Astronomy
words:
  - Sun
  - Mercury
  - Venus
  - Earth
  - Mars
  - Jupiter
  - Saturn
  - Uranus
  - Neptune
  - Pluto
  - Moon
  - Stars

The game will look like this:

Contributing

If you think this project can be improved, create a PR!

License

MIT

word-search-game's People

Contributors

sant123 avatar dependabot[bot] avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.