haxroomie

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #typescript #rust #deep-learning #linux #docker #nodejs #awesome #awesome-list #security #mcp #open-source

(★ 17)

Haxroomie is an API and CLI to run headless HaxBall rooms without GUI.

haxroomie Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# haxroomie

Haxroomie is set of tools run headless HaxBall rooms without GUI.

Rooms can be run
- Programmatically using
  [haxroomie-core](https://github.com/morko/haxroomie/tree/master/packages/haxroomie-core)
- From the command line using
  [haxroomie-cli](https://github.com/morko/haxroomie/tree/master/packages/haxroomie-cli)

With haxroomie you can
  - run rooms without desktop environment
  - run multiple rooms with ease
  - use a modular plugin manager made by saviola
    - see [haxball-headless-manager](https://github.com/saviola777/haxball-headless-manager)
  - monitor and control rooms from command line
  - use the API to create an interface to run rooms

**If you are looking to how to run rooms in your VPS then you probably want
[haxroomie-cli](https://www.npmjs.com/package/haxroomie-cli).**

This repository is a monorepo containing the main API
[haxroomie-core](packages/haxroomie-core/) and interfaces using the API.

## Links

- [haxroomie-core](packages/haxroomie-core/) (API)
- [haxroomie-cli](packages/haxroomie-cli/) (Command Line Interface)
- [API Documentation](https://morko.github.io/haxroomie) (API documentation and tutorials)

## Contributing and Development

1. Clone/fork the repository.
2. Install main dependencies
```sh
npm install
```
3. Install dependencies and create links between the subpackages (handled by lerna).
```sh
npm run bootstrap
```
4. haxroomie-cli can be run from projects root.
```sh
npm start
```

I accept well documented pull request to master branch.

### Debugging

To enable more extensive logging for development, you can set environment variable `NODE_ENV=development`.

For even more extensive logging you can enable [Puppeteers](https://github.com/puppeteer/puppeteer/) debug logs by setting environment variable `DEBUG="puppeteer:*"`. See more about debugging puppeteer at https://developers.google.com/web/tools/puppeteer/debugging.

### Version Control

Development is done on the `master` branch and publishing to npm is also done
from `master`. If major update happens, then the old version will be branched
and new version will continue as `master`. Feature branches are highly engouraced.

## Running tests

Tests can be ran with `npm test` in the projects root, but they require a
token for the HaxBall room. The token(s) is loaded from environmental
variables.
e.g.
```
HR_TEST_TOKEN1="thr1.AAAAAF3nhJtzT2JftBYPmA.gBZ2x1ST7HU"
HR_TEST_TOKEN2="thr1.AAAAAF3nlPdWTSwonQ8zXw.KUYmmWsmPysfdaQ"
```

Currently you only need one test token, but in the future there might be some
tests for multiple rooms.

## Publishing

Publishing to npm is handled by [lerna](https://github.com/lerna/lerna) can be done with
```sh
npm run publish
```

This will build docs, format the JavaScript using linter, bump versions and publish all packages under `./packages`.

haxroomie

haxroomie Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

haxroomie

haxroomie Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README