Giter Club home page Giter Club logo

bwapi-lua's Introduction

BWAPI-Lua

Build status Documentation Status

Lua bindings for the Brood War API using the sol2 Lua bindings library, for the purposes of writing StarCraft AI using the Lua scripting language.

Currently supports BWAPI version 4.2.0 and Lua 5.1.5 (with planned support for Lua 5.3 and LuaJIT)

Quick Start

  • Install Starcraft, BWAPI, and BWAPI-Lua according to the installation guide
  • Download init.lua from examples/LuaExampleAI and move it to Starcraft/bwapi-data/AI
  • Run Chaoslauncher from the Chaoslauncher directory where BWAPI was installed (e.g. C:\Program Files (x86)\BWAPI\Chaoslauncher)
  • In Chaoslauncher's Plugins tab, enable BWAPI Injector [RELEASE] and (optionally) W-MODE
  • Start StarCraft (from Chaoslauncher) and create a new single player game. The AI should begin continuously mining and producing workers

Important Links

Preview: 'Hello World' AI

local Broodwar = BWAPI.Broodwar

function BWAPI.onStart()
  Broodwar:sendText("Hello world!")
end

Compiling and Testing

  • Install cmake and make sure it is available in the PATH
  • Clone this repository
  • Run make.bat to build. The resulting files can be found in build/Release
  • Run make.bat test to build and run the available tests of the Lua bindings

Contributing

Running make.bat projects will generate Visual Studio project/solution files inside the build directory. Once that's finished, open build/BWAPI_Lua.sln.

License

BWAPI-Lua is made available under the LGPLv3, the same license as BWAPI.

The licenses of all dependencies can be found in their respective directories within dependencies.

bwapi-lua's People

Contributors

squeek502 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.