Skip to content

haydar-can/beatconnect_client

This branch is 37 commits behind yadPe/beatconnect_client:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e063b1a · Jul 25, 2021
Jul 3, 2021
Jul 25, 2021
Sep 20, 2020
Apr 8, 2021
Mar 21, 2021
Jul 4, 2021
Jan 19, 2020
Apr 7, 2021
Apr 10, 2021
Jul 11, 2021
Oct 13, 2019
Nov 18, 2019
Jul 4, 2021
Apr 10, 2021
Apr 10, 2021
Oct 13, 2019
Apr 8, 2021
Jul 11, 2021
Aug 7, 2019
May 2, 2021
Apr 7, 2021
Jul 11, 2021
Jul 4, 2021

Repository files navigation

Beatconnect client license CircleCI

The official client for Beatconnect which is a mirror for Osu! Beatmaps

Table of contents:

Quick Tour

  • This App gives you access to all the beatmaps mirrored on Beatconnect. You can downloads multiple beatmaps that will be automaticaly imported into osu!

  • You can launch an IRC bot from the app that will make all available commands usable to peoples pming you and from all the matches chats that the bot is connected to. (how to connect docs soon..)
    Comming with the autobeat feature that send the Beatconnect download link in the #multuplayer channel each time host change the beatmap

  • Manage connected matchs

Technology

Documentation

Available ressources:

Development

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

Prerequisites

  • NodeJs v14 or higher and yarn

Installing for development

Note: Before running beatconnect yourself you will need a .env file and a Beatconnect token.

# Clone this repository
git clone https://github.com/yadPe/beatconnect_client.git

# Go into the repository
cd beatconnect_client

# Install dependencies
yarn

# Start the dev server and launch the app
yarn dev

# (if you're running WSL you will have to start electron from within Windows with "yarn electron-dev")

Building for production

Given node 14 or superiour and yarn are installed

You can run yarn dist: followed by one of win, linux or mac. It will build beatconnect for x64 platform only by default but if prefixed by -ia32 builder will also output x86 version. Build artifacts will by located inside the dist folder

Note: Before building beatconnect yourself you will need a .env file and a Beatconnect token.

Example

# Build beatconnect as nsis-web installer for Windows x64
yarn dist:win

# Build beatconnect as dmg and mac for OSX x64
yarn dist:mac

# Build beatconnect as AppImage and deb for linux x64 and x86
yarn dist:linux --ia32

Env file

The .env file must be located at the root of the project

BEATCONNECT_CLIENT_TOKEN=your-beatconnect-token
BEATCONNECT_HOST_URL=https://beatconnect.io/

Download test

  • Latest release available here

License

This project is licensed under the GNU V3.0 License.

About

The Beatconnect desktop app !

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 92.4%
  • Reason 6.6%
  • Other 1.0%