Skip to content

Commit

Permalink
Merge pull request #27 from yadPe/v0.1.5
Browse files Browse the repository at this point in the history
V0.1.5
  • Loading branch information
yadPe authored Sep 12, 2019
2 parents 855e363 + caddb1f commit af7db91
Show file tree
Hide file tree
Showing 69 changed files with 2,147 additions and 1,069 deletions.
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

39 changes: 34 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,39 @@
# Beatconnect client
The official client for [Beatconnect](https://beatconnect.io) which is a mirror for [Osu!](https://osu.ppy.sh/home) Beatmaps

This App gives you access to all the beatmaps mirrored on [Beatconnect](https://beatconnect.io). You can downloads multiple beatmaps that will be automaticaly imported into osu! </br>
Plus, you can launch an IRC bot from the app that will make all [available commands](./docs/commands.md) usable to peoples pming you and from all the matches chats that the bot is connected to. (how to connect docs soon..)
**Table of contents:**

<img src="https://cdn.discordapp.com/attachments/414474227710820352/606134985971204096/unknown.png">
<!-- toc -->

This is still under development.
- [Quick Tour](#quick-tour)
- [Technology](#technology)
- [Development](#development)
- [Download](#download)
- [License](#license)

## Getting Started
<!-- tocstop -->

## Quick Tour
- This App gives you access to all the beatmaps mirrored on [Beatconnect](https://beatconnect.io). You can downloads multiple beatmaps that will be automaticaly imported into osu! </br>
<img src="https://cdn.discordapp.com/attachments/414474227710820352/609783969952694283/unknown.png">

- You can launch an <b>IRC bot</b> from the app that will make all [available commands](./docs/commands.md) usable to peoples pming you and from all the matches chats that the bot is connected to. (how to connect docs soon..)</br>
Comming with the <b>autobeat</b> feature that send the Beatconnect download link in the #multuplayer channel each time host change the beatmap
<img src="./docs/m3krbwj3sfdG480M.gif">

- Manage connected matchs
<img src="https://cdn.discordapp.com/attachments/414474227710820352/609813246198939687/unknown.png">

## Technology

- The application is powered by **[Electron](https://electronjs.org),
with [React](https://facebook.github.io/react/),
[Redux](http://redux.js.org/),
and [NodeJs](https://nodejs.org)**

- The bot uses a slightly modified version of **[node-irc](https://github.com/yadPe/node-irc) to connect to game IRC.**

## Development

These instructions will get you a copy of the project up and running on your local machine.

Expand All @@ -34,6 +60,9 @@ $ npm run build
$ electron .
```

## Download
- Latest release available [here](https://github.com/yadPe/beatconnect_client/releases/latest)

## License

This project is licensed under the GNU V3.0 License.
Binary file added docs/m3krbwj3sfdG480M.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit af7db91

Please sign in to comment.