-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
54fa341
commit d115711
Showing
1 changed file
with
30 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,51 @@ | ||
# Armada Assault | ||
|
||
A collection of action generators that reads the game state and generates recommended actions. These action recommendations are reviewed by another module that makes the decision. | ||
[Generally Genius](https://corsaircoalition.github.io/) (GG) is a modular generals.io bot framework for development and analysis of game strategies and actions. [CorsairCoalition](https://corsaircoalition.github.io/) is a collection of components that form the GG framework. | ||
|
||
## Installation | ||
Armada Assault is a collection of action generators that reads the game state and recommend actions. These action recommendations are reviewed by another module that makes the decision. | ||
|
||
## Configuration | ||
|
||
Download `config.example.json` from the [documentation repository](https://github.com/CorsairCoalition/docs) and make desired changes. | ||
|
||
To setup other components, see the [detailed instructions](https://corsaircoalition.github.io/setup/) on the [project website](https://corsaircoalition.github.io/). | ||
|
||
## Execution | ||
|
||
Install and run the executable: | ||
|
||
```sh | ||
npm install -g @corsaircoalition/armada-assault | ||
armada-assault config.json | ||
``` | ||
npm install | ||
npm run build | ||
|
||
or run directly from npm library: | ||
|
||
```sh | ||
npx @corsaircoalition/armada-assault config.json | ||
``` | ||
|
||
## Configuration | ||
or use docker: | ||
|
||
Copy `config.json.example` to `config.json` and make desired changes. | ||
```sh | ||
docker run -it ./config.json:/config.json ghcr.io/corsaircoalition/armadaassault:latest | ||
``` | ||
|
||
## Usage | ||
|
||
``` | ||
Usage: node . [options] <configFile> [actions...] | ||
Usage: @corsaircoalition/armada-assault [options] <configFile> [actions...] | ||
a modular generals.io bot that implements advanced learning techniques | ||
generals.io bot actions generator | ||
Options: | ||
-V, --version output the version number | ||
-c, --config <path> path to config file (default: "config.json") | ||
-d, --debug enable debugging (default: false) | ||
-h, --help display help for command | ||
-V, --version output the version number | ||
-d, --debug enable debugging (default: false) | ||
-h, --help display help for command | ||
``` | ||
|
||
## Example | ||
|
||
``` | ||
node . config.json attack explore spread | ||
npx @corsaircoalition/armada-assault config.json attack explore spread | ||
``` |