goexmars

goexmars

exMars binding for go. This uses the purego package to call the shared library, without any cgo. It also includes other goodies like go structs for the parsed warriors and similarity helpers.

Features

• Fight/FightNamed support 1 to 6 warriors for fights.
• Assemble returns normalized assembled Redcode (labels/macros/comments are not preserved) as string.
• AssembleParsed parses commands from normalized Redcode and reads ;name, ;author, and numeric END from the original source.
• Similarity helper to compute similarity between two warriors [0,1].

Usage

Fight

package main

import (
	"fmt"
	"log"

	"github.com/BigJk/goexmars"
)

func main() {
	imp := `
        ;redcode-94
        ;name Imp
        MOV 0, 1
        END
`

	dwarf := `
        ;redcode-94
        ;name Dwarf
        ADD #4, 3
        MOV 2, @2
        JMP -2, 0
        DAT #0, #0
        END
`

	cfg := goexmars.DefaultConfig.SetRounds(50)

	result, err := goexmars.Fight([]string{imp, dwarf}, cfg)
	if err != nil {
		log.Printf("fight failed: %v", err)
	}

	fmt.Printf("wins=%v ties=%d\n", result.Wins, result.Ties)
	if result.Diagnostics != "" {
		fmt.Printf("diagnostics:\n%s\n", result.Diagnostics)
	}
}

Validate

package main

import (
	"fmt"

	"github.com/BigJk/goexmars"
)

func main() {
	warrior := `
;redcode-94
;name Broken
MOV.Z 0, 1
END
`

	if err := goexmars.Validate(warrior, goexmars.DefaultConfig); err != nil {
		fmt.Printf("invalid warrior:\n%s\n", err)
		return
	}

	fmt.Println("warrior is valid")
}

FightNamed

package main

import (
	"fmt"

	"github.com/BigJk/goexmars"
)

func main() {
	imp := `
;redcode-94
;name Imp
MOV 0, 1
END
`

	result, err := goexmars.FightNamed(map[string]string{
		"alpha": imp,
		"beta":  imp,
		"gamma": imp,
	}, goexmars.DefaultConfig.SetRounds(10))
	if err != nil {
		fmt.Println("fight error:", err)
	}

	alphaWins, ties := result.Get("alpha")
	fmt.Printf("alpha wins=%d ties=%d\n", alphaWins, ties)
	fmt.Printf("all wins=%v\n", result.Wins)
}

Assemble

package main

import (
	"fmt"

	"github.com/BigJk/goexmars"
)

func main() {
	warrior := `
;redcode-94
;name Example
step  DAT #0, #0
start MOV step, >step
      JMP start
END 0
`

	assembled, err := goexmars.Assemble(warrior, goexmars.DefaultConfig)
	if err != nil {
		fmt.Printf("assemble failed:\n%s\n", err)
		return
	}

	fmt.Println("normalized redcode:")
fmt.Println(assembled)
}

AssembleParsed

package main

import (
	"fmt"

	"github.com/BigJk/goexmars"
)

func main() {
	warrior := `
;redcode-94
;name Example
;author You
start MOV 0, 1
END 0
`

	parsed, err := goexmars.AssembleParsed(warrior, goexmars.DefaultConfig)
	if err != nil {
		fmt.Println("assemble/parse error:", err)
		return
	}

	fmt.Printf("name=%q author=%q end=%d\n", parsed.Name, parsed.Author, parsed.End)
	for _, cmd := range parsed.Commands {
		fmt.Println(cmd.String())
	}

	// Re-render back to normalized redcode (+ parsed metadata)
	fmt.Println(parsed.String())
}

Shared Library

You need the shared library to run the code. You can build it yourself or download it from the releases page. It needs to be placed in the ./lib directory relative to the executable, or define the GOEXMARS_LIB_PATH environment variable to point to the shared library.

Build shared library

• The C sources are under ./exmars
• Build the shared library before building Go code:

cd exmars
./build.sh

This produces libexmars.dylib on macOS or libexmars.so on Linux.

Credits

• exMars