based on scrAI by NickToony
scrAI is a Screeps AI written in Java. Through the use of ST-JS (http://st-js.github.io/) and some Maven magic, I can write my AI implementation in pure Java, compile it to Javascript, concatenate into one large file, and push it to Screeps using Grunt.
By using a strongly typed and class based language, this project sets out to develop a more complex and maintainable AI.
- This is a blank template for you to create your own Screeps bot in Java
- Unit Testing skeleton is in place
- Integration testing using screeps-server-mockup is also in place
Not Provided
The following are external dependencies you must install to get the most out of this setup
- Maven
- (optional) with M2_HOME environment variable defined
- Screeps Grunt Task
- http://support.screeps.com/hc/en-us/articles/203022512-Commiting-local-scripts-using-Grunt
- requires Grunt and NPM
- build task is commented out in the pom.xml
- grunt-screeps (https://docs.screeps.com/contributed/advanced_grunt.html) requires screepsmod-auth (https://github.com/ScreepsMods/screepsmod-auth) to be installed on your private server
Provided
The following are provided by the Maven pom.xml file.
- ST-JS
- ST-JS Javascript Bridge
- Google's maven-replacer-plugin
- YUI Compressor Maven plugin
Adding your Screeps login
The compiled code is automatically uploaded to your Screeps account. I recommend using this, as it'll handle flattening the packages for you. It also includes the custom stjs.js file.
- Duplicate the Gruntfile.example.js file to Gruntfile.js
- Replace the email and password fields with your details
- Gruntfile.js is already added to the .gitignore
- Optional: Uncomment the grunt-screeps plugin exec in pom.xml
Compiling and Deploying
- Build the java project.
- Executing the Maven task prepare-package will run the remaining required steps.
Tip: You can add a new Build Configuration in Intellij for example, that runs the command line prepare-package. Add a "Before launch" parameter that runs "Make".
The 4 steps performed by the Maven task are as follows:
- Execute ST-JS with the Javascript bridge, compiling all Java classes to Javascript.
- Run the maven-replacer-plugin to modify the generated Javascript to be Screeps friendly.
- Run the YUI-compressor to combine all the generated javascript files into one file. Note: this step also includes the custom stjs.js found under /src/main/javascript. This is a Screeps-friendly version of the script.
- Run the grunt task to upload the correct files, without directories/packages.
Module Importing, Exporting and STJS
Since I changed the setup to instead combine all scripts into one single javascript file, you no longer need to import/export modules. This means the previous dirty hacks to implement the unsupported Javascript syntax in Java is not necessary.
STJS still requires its methods though, so a custom STJS implementation is provided that will work when included inside the final script.
The advantages of using a single script are:
- Importing/Exporting not necessary, don't need to create dirty hacks in Java to implement them
- Requiring a module in screeps could take an unpredictable amount of time. Performance is a lot better if you just have one script.
Lodash
Screeps likes to use javascript which is just plain difficult for ST-JS to bridge. An example of this is the Game.rooms hashmap - which doesn't bridge at all well! To get around this, you can import the Lodash module, and use that to iterate over Javascript collections.
GlobalController
The GlobalController looks at the map as a whole. It doesn't worry about managing each rooms contents, but the interactions between rooms. It decides where to reinforce, where to expand (or assault) and the parameters affecting each room.
RoomController
A layer below GlobalController, this controller is given the responsibility of managing one specific room.