# osu-buffer

> Allows you to read and write packets/files for the game osu!

Latest version **2.0.2** (published 2021-04-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install osu-buffer
pnpm add osu-buffer
yarn add osu-buffer
bun add osu-buffer
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2021-04-07 |
| First published | 2017-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 24.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Dillon |
| Maintainers | itsyuka |

## Links

- npm: https://www.npmjs.com/package/osu-buffer
- Repository: https://github.com/Itsyuka/osu-buffer
- Homepage: https://github.com/Itsyuka/osu-buffer#readme
- Issues: https://github.com/Itsyuka/osu-buffer/issues
- npm.io page: https://npm.io/package/osu-buffer

## Recent versions

- 2.0.2 (latest) — 2021-04-07
- 2.0.1 — 2021-04-06
- 2.0.0 — 2021-04-06
- 1.3.5 — 2020-01-30
- 1.3.3 — 2020-01-10
- 1.3.2 — 2019-07-04
- 1.3.1 — 2017-07-12
- 1.2.3 — 2017-06-27

## README

# osu-buffer [![npm version](https://badge.fury.io/js/osu-buffer.svg)](https://badge.fury.io/js/osu-buffer) [![CodeFactor](https://www.codefactor.io/repository/github/itsyuka/osu-buffer/badge)](https://www.codefactor.io/repository/github/itsyuka/osu-buffer)

This package allows you to create a buffer that allows the readability of the packets or files of the game called osu!

This does not automagically convert it, you do need to put some work to make it possible.

## How to use
#### Require the package
```ecmascript 6
const { OsuReader, OsuWriter } = require('osu-buffer')
```

#### Creating a new OsuReader from Node buffer
```ecmascript 6
let buffer = Buffer.from([]);
let reader = new OsuReader(buffer.buffer);
```

#### Creating a new OsuReader from String
```ecmascript 6
let reader = OsuReader.fromString("");
```

#### Creating a new OsuWriter
```ecmascript 6
let write = new OsuWriter(); // Can be empty or ArrayBuffer
```

## License
MIT License

Copyright (c) 2021 Dillon Modine-Thuen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---
_Source: https://npm.io/package/osu-buffer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
