https://github.com/gruppe-adler/node-arma3sync-lib

Node.js library to read/write Arma3Sync config data.
https://github.com/gruppe-adler/node-arma3sync-lib

arma3sync hacktoberfest library node

Last synced: about 2 months ago
JSON representation

Node.js library to read/write Arma3Sync config data.

• Host: GitHub
• URL: https://github.com/gruppe-adler/node-arma3sync-lib
• Owner: gruppe-adler
• Created: 2019-08-18T19:19:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-02T17:56:35.000Z (about 2 years ago)
• Last Synced: 2023-08-03T08:38:41.361Z (over 1 year ago)
• Topics: arma3sync, hacktoberfest, library, node
• Language: TypeScript
• Homepage:
• Size: 369 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![tests](https://img.shields.io/github/workflow/status/gruppe-adler/node-arma3sync-lib/Node%20CI?label=tests)

[![codecov](https://codecov.io/gh/gruppe-adler/node-arma3sync-lib/branch/add-cc/graph/badge.svg)](https://codecov.io/gh/gruppe-adler/node-arma3sync-lib)

# node-arma3sync-lib

Read and write [Arma3Sync](svn://www.sonsofexiled.fr/repository/ArmA3Sync/trunk) `.a3s` config data using JavaScript.

```ts

const a3s = new A3sDirectory('/my/repo/path/.a3s/')

a3s.getEvents().then(events => { /*pure awesome*/});

```

## Configuration

Currently uses [config](https://www.npmjs.com/package/config) and expects this config structure to exist:

```js

{

  "arma3sync-lib": {

    "publicURL": "", // public repository URL, ex. `http://mods.my-clan.com/`

    "repoName": "", // repository name

    "repoPath": "" // file path to the repository, ex. `/var/lib/a3s/mods`

  }

}

```