5 Commits

Author SHA1 Message Date
bradley.richins
221f4e59e1 Updated README.md 2020-10-20 00:08:37 -06:00
bradley.richins
8ccafd5c0c Renamed from LICENSE 2020-10-20 00:06:19 -06:00
bradley.richins
59fcf3e2f0 Renamed to COPYING 2020-10-20 00:05:33 -06:00
bradley.richins
59cc61105a Updated README.md 2020-10-19 22:37:00 -06:00
bradley.richins
ea438a7f40 Example Glyph Banner 2020-10-19 22:36:42 -06:00
3 changed files with 100 additions and 12 deletions

View File

BIN
NewLennon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 228 KiB

View File

@@ -16,6 +16,8 @@ go get -u gitlab.com/bradley.richins/nmslib
## Usage ## Usage
**Example:**
```golang ```golang
package main package main
@@ -31,13 +33,99 @@ func main() {
if err != nil { if err != nil {
panic(err) panic(err)
} }
fmt.Printf("Input: \t%s\nExpecting: \t042F:0079:0D55:006A\nHave: \t%s\n", portalcode, tstvar) fmt.Printf("Input:\t%s\nExpecting:\t042F:0079:0D55:006A\nHave:\t%s\n", portalcode, tstvar)
nmslib.CreateBanner(portalcode, "NewLennon.png", 0) nmslib.CreateBanner(portalcode, "NewLennon.png", 0)
fmt.Println(nmslib.Korvax2Eng("eapoluch")) fmt.Println(nmslib.Korvax2Eng("eapoluch"))
fmt.Println(nmslib.Eng2Korvax("emergency")) fmt.Println(nmslib.Eng2Korvax("emergency"))
} }
``` ```
### Creating a Glyph banner with CreateBanner()
This function takes 3 parameters:
* portalcode: 12 char hex string of portal location
* savename: Save location and name
* Horizontal/Vertical layout: 0 is horizontal, 1 is vertical
**Example:**
Horizontal Layout for Galactic Hub [HUB10-6A Icarus Sun](https://nomanssky.gamepedia.com/HUB10-6A_Icarus_Sun) Eniwa 68/L3
```golang
nmslib.CreateBanner("006afa556c30", "NewLennon.png", 0)
```
![](NewLennon.png)
### Converting Portal code to Galactic address with P2gc()
This function only takes 1 parameter and returns a string
* portalcode: 12 char hex string of portal glyphs
**Example:**
```golang
ga, _ := nmslib.P3gc("006afa556c30")
fmt.Println(ga)
```
Output:
``042F:0079:0D55:006A``
### Converting Galactic coordinates to Portal codes with Gc2p()
This function only takes 1 parameter and returns a string
* galacticaddress: 16 char 4 block hex address
**Example:**
```golang
pc, _ := nmslib.P3gc("042F:0079:0D55:006A")
fmt.Println(pc)
```
Output:
``006AFA556C30``
### Translate Korvax to English with Korvax2Eng()
This function takes only 1 parameter and returns a string
* korvaxword: Any known Korvaxen word (ex. eapoluch)
**Example:**
```golang
fmt.Println(Korvax2Eng("eapoluch"))
```
Output:
``emergency``
### Translate English to Korvax with Eng2Korvax()
This function takes only 1 parameter and returns a string
* engword: English word to attempt conversion
**Example:**
```golang
fmt.Println(Eng2Korvax("emergency"))
```
Output:
``eapoluch``
## License ## License
[MIT](https://choosealicense.com/licenses/mit/) [MIT](COPYING)