Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
aadityabhatia committed Aug 12, 2023
1 parent 8ddb93c commit 6d58c98
Showing 1 changed file with 32 additions and 7 deletions.
39 changes: 32 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,45 @@
# Commander Cortex

A modular generals.io bot framework for development and analysis of game strategies and actions
[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
Commander Cortex is the user interface that controls the bot framework, displays game status, and synchronizes other compenents.

## 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/commander-cortex
commander-cortex config.json
```
npm install
npm run build

or run directly from npm library:

```sh
npx @corsaircoalition/commander-cortex config.json
```

## Configuration
or use docker:

Copy `config.json.example` to `config.json` and make updates as needed.
```sh
docker run -it -v ./config.json:/config.json ghcr.io/corsaircoalition/commandercortex:latest
```

## Usage

```
node . config.json
Usage: @corsaircoalition/commander-cortex [options] <configFile>
a modular generals.io bot framework for development and analysis of game strategies and actions
Options:
-V, --version output the version number
-d, --debug enable debugging (default: false)
-h, --help display help for command
```

0 comments on commit 6d58c98

Please sign in to comment.