chippydip / go-sc2ai

Go version of the Starcraft II AI API

go-sc2ai

Go implementation of the Starcraft II AI API

Quick start

Prerequisites

• Install golang >= 1.13
  https://golang.org/dl/
• Install Starcraft II game
  https://starcraft2.com/en-us/ (free version is okay)
• Download Ladder
  • Join Discord messenger: https://discordapp.com/invite/Emm5Ztz
  • Use !maps command to get archive link
  • Download, unpack and copy files into Starcraft II Maps folder (e.g. C:/Program Files (x86)/StarCraft II/Maps)

Build and run examples

• Create working dir:

  mkdir /path/godev
  cd /path/godev/

• Clone project:

  git clone [email protected]:chippydip/go-sc2ai.git
  cd go-sc2ai/

• Build and run example:

  go run .\examples\zerg_rush

Start writing your own bot

• Make project dir:

  mkdir /path/mycoolbot
  cd /path/mycoolbot/
  go mod init bot
  go get -u github.com/chippydip/go-sc2ai

• Copy main.go from examples/stub_bot into your project dir
• Build and run

  go run .

• Add some cool new stuff
• Build > Run > Test > Repeat
• ???
• PROFIT

Useful links

• Get help in Discord: https://discord.gg/Emm5Ztz
• Learn golang: https://tour.golang.org/
• Starcraft II AI Wiki: http://wiki.sc2ai.net/Main_Page
• More maps: https://github.com/ttinies/sc2gameMapRepo

go-sc2ai's Issues

Debug package

Hi,

could you add a debug package that allows easy usage of blizzards ingame debug messages/spheres/squares?

I know how to add it manually, but it would make sense to have that at the go-sc2ai package level I think. Whenever you have time! gracias

Addition of SkipReplayIf() method to replay runner

Can you add a SkipReplayIf() method to runner (and maybe even separate runner for replays from a runner for normal games)?

I'd like to be able to query the replay info struct in that method, so that I can return true if certain conditions aren't fulfilled, e.g. MMR too low.

CWD not supported for replays

This works for me:

        cwd, _ := os.Getwd()
        replayPath := filepath.Join(cwd, "data/replays/test.SC2Replay")

and this won't:

        replayPath := "data/replays/test.SC2Replay"

I presume that somewhere in the replay opening code, it uses cwd, _ := os.Executable() or something like that to get the current working directory, but if you use symlinks, etc, then using os.Executable() gives you the "wrong" path. For the same reason it also fails when we direct it at the folder as such:

        replayPath := "data/replays/

Absolute paths work.

Expose functions in Builder

Can you make Builder.getProductionCost and Builder.canAfford public?

Gracias

Add GetCurrentReplay() to runner

It would be helpful to find out which replay is currently being parsed/replayed, since that information isn't available when looping on an entire folder. Maybe runner could get a runner.GetCurrentReplay() method for that purpose?

Cycling through replays causes runtime errors sometimes

This is using the SetReplay feature on a folder.
Note that I have a line in the coordinator.go code that exits StartReplay() immediately via return statement, when certain conditions aren't fulfilled (e.g. MMR too low). Then this sometimes happens:

2019-01-22 16:21:17 [Notice] panic.go:16: runtime error: invalid memory address or nil pointer dereference
2019-01-22 16:21:17 [Notice] panic.go:27: C:/Go/src/runtime/asm_amd64.s:522 in runtime.call32
2019-01-22 16:21:17 [Notice] panic.go:27: C:/Go/src/runtime/panic.go:514 in runtime.gopanic
2019-01-22 16:21:17 [Notice] panic.go:27: C:/Go/src/runtime/panic.go:82 in runtime.panicmem
2019-01-22 16:21:17 [Notice] panic.go:27: C:/Go/src/runtime/signal_windows.go:206 in runtime.sigpanic
2019-01-22 16:21:17 [Notice] panic.go:27: D:/Projects/Go/src/github.com/chippydip/go-sc2ai/client/client.go:185 in github.com/chippydip/go-sc2ai/client.(*Client).Init
2019-01-22 16:21:17 [Notice] panic.go:27: D:/Projects/Go/src/github.com/chippydip/go-sc2ai/runner/coordinator.go:327 in github.com/chippydip/go-sc2ai/runner.runAgent
2019-01-22 16:21:17 [Notice] panic.go:27: D:/Projects/Go/src/github.com/chippydip/go-sc2ai/runner/coordinator.go:304 in github.com/chippydip/go-sc2ai/runner.Run.func1
2019-01-22 16:21:17 [Notice] panic.go:27: C:/Go/src/runtime/asm_amd64.s:1334 in runtime.goexit

Is there a way to automatically download the map for replays?

Right now it looks as such when trying to run a replay that we don't have a map for (cached or otherwise):

[Notice] coordinator.go:355: Unable to get replay info: ParsingError: 
Possible corruption - Failed to open the map archive: C:\ProgramData\Blizzard Entertainment\Battle.net\Cache\2a\6f\2a6f1c32722b0c4c83149ccf543d1453fb423610327d71dc72e63601f64bfd76.s2ma

Process finished with exit code 1

Is it possible somehow to get SC2 to download the map automatically - as it would if you open the replay by hand?