https://github.com/workingdog/scalams

Scala.js façade to milsymbol.js
https://github.com/workingdog/scalams

Last synced: 11 months ago
JSON representation

Scala.js façade to milsymbol.js

• Host: GitHub
• URL: https://github.com/workingdog/scalams
• Owner: workingDog
• Created: 2016-07-22T04:53:45.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-08-23T09:07:30.000Z (almost 9 years ago)
• Last Synced: 2025-05-31T14:29:27.145Z (about 1 year ago)
• Language: Scala
• Size: 43 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGES.md

Awesome Lists containing this project

README

          
# Scala.js façade to milsymbol.js 

This library **ScalaMS** is a Scala interface to the [SPATIAL ILLUSIONS](http://spatialillusions.com/milsymbol/) Military Unit Symbols in JavaScript,

 [milsymbol.js](https://github.com/spatialillusions/milsymbol).

[milsymbol.js](https://github.com/spatialillusions/milsymbol) is a library in pure JavaScript that creates SVG symbols according to MIL-STD-2525C,

MIL-STD-2525D and NATO STANAG APP6(b). 

## References

 

1) [milsymbol.js on GitHub](https://github.com/spatialillusions/milsymbol)

## Dependencies

See the build.sbt file.

Using Scala.js-0.6.19.

## Usage

To use the last release (for milsymbol.js 1.3.0) add the following dependency to your build.sbt:

    libraryDependencies += "com.github.workingDog" %%% "scalams" % "1.3.0"

To create a new symbol:

    val sym = new Symbol("sfgpewrh--mt", new SymbolOptions {

      override val quantity: js.UndefOr[String] = "200"

      override val staffComments: js.UndefOr[String] = "for reinforcements".toUpperCase

      override val direction: js.UndefOr[Double] = 750 * 360 / 6400

      override val `type`: js.UndefOr[String] = "machine gun"

      override val dtg: js.UndefOr[String] = "30140000ZSEP97"

      override val location: js.UndefOr[String] = "0900000.0E570306.0N"

    })

See also [CesiumMil](https://github.com/workingDog/CesiumMil) for a basic example of using 

[ScalaMS](https://github.com/workingDog/ScalaMS) and [CesiumScala](https://github.com/workingDog/CesiumScala)

## Compiling and installation 

To compile and generate a javascript file from the source code:

    sbt fullOptJS 

The javascript file (scalams-opt.js) will be in the "./target/scala-2.11" directory.

To publish **ScalaMS** to your local (Ivy) repository, simply type:

    sbt publishLocal

    

Then put this in your build.sbt file

    libraryDependencies += "com.github.workingDog" %%% "scalams" % "1.3.1-SNAPSHOT

## Documentations

Refer to the original [overview](http://spatialillusions.com/milsymbol/index.html) documentation and 

the [milsymbol API](http://spatialillusions.com/milsymbol/docs/index.html) documentation.

To generate the Scala doc:

    

    sbt doc

The Scala API doc will be in the "./target/scala-2.11/api" directory.

## Status

stable