diff --git a/README.md b/README.md index c866f3b..0e0241d 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ NMSlib is a GoLang package for dealing with converting Galactic coordinates to Portal codes and vice versa. -NMSlib also translates in game languages to english. +NMSlib also translates in game languages (Korvax, Gek Vy'Keen and Atlas) to english, and create portal banners. ## Installation @@ -41,9 +41,9 @@ func main() { nmslib.CreateBanner(portalcode, "NewLennon.png", 0) nmslib.CreateBanner(RndPortal(), "Random.png", 0) - fmt.Println(Translate{"KIHTYOMOLES"}.Kor2Eng()) - korvax := Translate{"Contraband"} - fmt.Println(korvax.Eng2Kor()) + fmt.Println(nmslib.Translate{"KIHTYOMOLES"}.Kor2Eng()) + korvax := nmslib.Translate{"Contraband"} + fmt.Println(nmslib.korvax.Eng2Kor()) } ``` @@ -66,6 +66,20 @@ nmslib.CreateBanner("006AFA556C30", "NewLennon.png", 0) ![](NewLennon.png) +Vertical layout for a random address + +```golang +nmslib.CreateBanner(nmslib.RndPortal(), "ranportal.png", 11) +``` + +![](ranportal_scaled.png) + +_Note: Images shown in readme.md have been scaled down in gimp._ + +_Original Vertical: 256x3072px_ + +_Original: Horizontal: 3072x256px_ + ### Converting Portal code to Galactic address with P2gc() This function only takes 1 parameter and returns a string and error @@ -118,7 +132,7 @@ This function takes only 1 parameter and returns a string **Example:** ```golang -fmt.Println(Translate{"Paka"}.Atl2Eng()) +fmt.Println(nmslib.Translate{"Paka"}.Atl2Eng()) ``` Output: @@ -134,7 +148,7 @@ This function takes only 1 parameter and returns a string **Example:** ```golang -korvax := Translate{"Contraband"} +korvax := nmslib.Translate{"Contraband"} fmt.Println(korvax.Eng2Kor()) ``` @@ -146,20 +160,20 @@ Output: ### Language commands Gek: -- ``Translate{word}.Gek2Eng()`` -- ``Translate{word}.Eng2Gek()`` +- ``Translate{string}.Gek2Eng()`` +- ``Translate{string}.Eng2Gek()`` Korvax: -- ``Translate{word}.Kor2Eng()`` -- ``Translate{word}.Eng2Kor()`` +- ``Translate{string}.Kor2Eng()`` +- ``Translate{string}.Eng2Kor()`` Vy'keen: -- ``Translate{word}.Vyk2Eng()`` -- ``Translate{word}.Eng2Vyk()`` +- ``Translate{string}.Vyk2Eng()`` +- ``Translate{string}.Eng2Vyk()`` Atlas: -- ``Translate{word}.Atl2Eng()`` -- ``Translate{word}.Eng2Atl()`` +- ``Translate{string}.Atl2Eng()`` +- ``Translate{string}.Eng2Atl()`` ## Random Portal address @@ -168,12 +182,15 @@ Atlas: **Example:** ```golang -fmt.Println(RndPortal()) +fmt.Println(nmslib.RndPortal()) +fmt.Println(nmslib.RndPortal()) ``` -**Outout:** +**Output:** ``10EFABDEA373`` +``11EAB355FC8E`` + ## License [MIT](COPYING)