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 cb9508a
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
@@ -1,20 +1,43 @@
# Commander Cortex

A modular generals.io bot framework for development and analysis of game strategies and actions
[Corsair Coalition](https://corsaircoalition.github.io/) is a modular generals.io bot framework for development and analysis of game strategies and actions. Commander Cortex is the user interface that controls the bot framework, displays game status, and synchronizes other compenents.

## Installation
## 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 ./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 cb9508a

Please sign in to comment.