search

vjurenka / BWMirror-Generator

Generator for BwMirror API
Other
7 stars 7 forks source link

Instructions to run BWMirror-Generator #4

Open heinermann opened 8 years ago

heinermann commented 8 years ago

There are no instructions for setting up and running BWMirror-Generator. It's important to have instructions so that potential contributors can get up to speed with minimal effort.

Running CJavaPipeline in intelliJ gives me several errors, along the lines of...

Error on line 9 in /C:/Users/Adam/BWMirror-Generator/generated/bwta/BaseLocation.java:9: error: package bwapi does not exist
import bwapi.Position;
            ^Error on line 10 in /C:/Users/Adam/BWMirror-Generator/generated/bwta/BaseLocation.java:10: error: package bwapi does not exist
import bwapi.TilePosition;
            ^Error on line 11 in /C:/Users/Adam/BWMirror-Generator/generated/bwta/BaseLocation.java:11: error: package bwapi does not exist
import bwapi.Player;
            ^Error on line 12 in /C:/Users/Adam/BWMirror-Generator/generated/bwta/BaseLocation.java:12: error: package bwapi does not exist
import bwapi.Unit;
            ^Error on line 13 in /C:/Users/Adam/BWMirror-Generator/generated/bwta/BaseLocation.java:13: error: package bwapi does not exist
vjurenka commented 8 years ago

Hello, I don't think the project is currently in a state, where it could be run with minimal effort, however here are the WIP instructions: https://docs.google.com/document/d/1KlTohhZP-4Ob_tvTfxhVKq27Uvxemhnf_c7JEN_3Ttc/edit?usp=sharing

The code is pretty messy and full of hacks, as this project's transition from bwapi to bwapi4 was a bit rushed. The refactoring would require quite a a lot of time, but shouldn't be brutaly complicated once a person gets the project to run and gets a hang things.

Most of the problems are the check's, if we're generating bwapi3 or bwapi4. All the classes containing these checks should be split into two subclasses. Using a builder design pattern, one could then get the some kind of generator context, which would be valid for the desired mode (bwapi3/bwapi4).

Thank you for your interest in the BWAPI project :)