nmslib/README.md

NMSlib

NMSlib is a GoLang package for dealing with converting Galactic coordinates to Portal codes and vice versa.

NMSlib also translates in game languages (Korvax, Gek Vy'Keen and Atlas) to english, and create portal banners.

Installation

To install this module use go get

go get -u gitlab.com/Raum0x2A/nmslib

Usage

Example:

package main

import (
    "fmt"

    "gitlab.com/Raum0x2A/nmslib"
)

func main() {
    portalcode := "21F2F8EDB94D"
    galacticCoords, err := nmslib.P2gc(portalcode)
    if err != nil {
        panic(err)
    }
    fmt.Printf("Input:\t%s\nOutput:\t%s\n", portalcode, galacticCoords)
	
    g2p, err := nmslib.Gc2p("014C:0077:06DA:01F2", 2)
    if err != nil {
        panic(err)
    }
    fmt.Printf("Input:\t014C:0077:06DA:01F2\nOutput:\t%s\n", g2p)

    _ := nmslib.CreateBanner(portalcode, "./NMH-BlueDream.png", 0)
    _ := nmslib.CreateBanner(nmslib.RndPortal(), "./Random.png", 0)
	
    fmt.Println(nmslib.Translate{Lang: "korvax"}.ToEng("KIHTYOMOLES"))
    korvax := nmslib.Translate{"english"}
    fmt.Println(korvax.ToKorvax("Contraband"))
}

Creating a Glyph banner

This function takes 3 parameters and reurns an error

• portalcode: 12 char hex string of portal location
• savename: Save location and name
• layout:
  • 00 or 0 is horizontal in light mode
  • 01 or 1 is horizontal in dark mode
  • 11 is vertical in dark mode
  • 10 is vertical in light mode

Example:

Horizontal Layout for the NMH Capital planet Blue Dream (aka Omins XI) in the Notric-Lis XIII system in the Lahanhar Conflux region

err := nmslib.CreateBanner("21F2F8EDB94D", "NMH-BlueDream.png", 0)
if err !=nil {
    panic(err)
}

Vertical layout for a random address

err := nmslib.CreateBanner(nmslib.RndPortal(), "ranportal.png", 11)
if err != nil {
    panic(err)
}

Note: Image shown in readme.md's vertical example have been scaled down in gimp for easier viewing on gitlab.

Original ranportal.png: 256x3072px

Converting Portal code to Galactic address

This function only takes 1 parameter and returns a string and error

• portalcode: 12 char hex string of portal glyphs

Example:

ga, _ := nmslib.P2gc("21F2F8EDB94D")
fmt.Println(ga)

Output:

014C:0077:06DA:01F2

Converting Galactic coordinates to Portal codes

This function only takes 2 parameters and returns a string and error

• galacticaddress: 16 char 4 block hex address
• Planet ID [1-6]

Example:

pc, _ := nmslib.Gc2p("014C:0077:06DA:01F2", 2)
fmt.Println(pc)

Output:

21F2F8EDB94D

Translate Words

Supported languages

• Korvax
• Gek
• Vy'keen
• Atlas

Translate Atlas to English

This function takes only 1 parameter and returns a string

• Word: Any known Atlas word (ex. Paka)

note: Translating to english will always result in the lowercase equivilent word

Example:

fmt.Println(nmslib.Translate{Lang: "atlas"}.ToEng("Paka"))

Output:

awake

Translate English to Korvax

This function takes only 1 parameter and returns a string

• engword: English word to attempt conversion

Example:

korvax := nmslib.Translate{"english"}
fmt.Println(korvax.ToKorvax("Contraband"))

Output:

Zelidovoso

Language commands

• Translate{Lang: string}.ToEng(string)
• Translate{Lang: string}.ToKorvax(string)
• Translate{Lang: string}.ToGek(string)
• Translate{Lang: string}.ToVykeen(string)
• Translate{Lang: string}.ToAtlat(string)

Possible Lang string options

• "english"
• "korvax"
• "gek"
• "vykeen"
• "atlas"

Random Portal address

Generate random portal codes

• Atlas Station
• Black Hole
• Random address

All random address created will default to the planet index 1 to help ensure there the address is valid

Example:

fmt.Println(nmslib.RndPortal())
fmt.Println(nmslib.RndPortal())
fmt.Println(nmslib.RndAtlas())
fmt.Println(nmslib.RndBH())

Output examples:

10EFABDEA373

11EAB355FC8E

107AC0E190D1

10796D57AE15

---

A Proud member of NMH Hub