README
¶
BaseList
Table of Contents
About
Baselist is a command-line tool that generates popmenus for easy supergroup base access. It accepts a CSV file and produces a .mnu file.
When a popmenu option is selected, it executes the enterbasefrompasscode command with the base code from the CSV file. You can easily move between bases by using the generated popmenu while near a base portal.
Installation
go install gitlab.com/cityofheroes/baselist@latest
Sample output
A sample popmenu is provided in this repo.
Usage
generate subcommand
Parsing a CSV file and write the popmenu to stdout:
baselist generate -i ./sample.csv
Writing the popmenu to an arbitrary file:
baselist generate -i ./sample.csv -o path/to/myfile
NOTE: A suffix of .mnu is applied to the output if no extension is supplied.
Installing the output popmenu to the local City of Heroes installation:
baselist generate -i ./sample.csv --coh-install path/to/game/install --install filename
# can also use the COH_INSTALL shell variable
export COH_INSTALL=path/to/game/install
baselise generate -i ./sample.csv --install filename
Expected CSV format
The CSV file format is expected to have certain fields. All fields are case-insensitive. Leading and trailing whitespace are ignored. Fields other than the ones described below are ignored.
| Field | Required? | Description | Default | Example |
|---|---|---|---|---|
| Code | YES | The supergroup base code | none | TAXI-4000 |
| Name | no | The name of the supergroup base, which can be any value and does not have to match the in-game supergroup | the Code field | Pizza Ducks! |
| Credit | no | Any credit for the base. This is a good place to put global handles. | none | @Dacy @Someone,@SomeoneElse |
| Server | no | The name of the server for this base | Everlasting | Excelsior |
| Group | no | The name of this base's group, which is just a logical name to organize bases by category | Ungrouped | Fantasy |
| Working | no | Whether the base code is actually working. Useful to flag unworking codes in the popmenu, but leave them in the list. | true | Yes, Y, True, T, 1, and blank are interpreted as working No, N, False, F, and 0 are interpreted as not working |
A sample of this format is included in this project.
Maintainers
John Bass [email protected] @MaceVanHoffen
Documentation
¶
There is no documentation for this package.
Source Files