Beatconnect client

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

Table of contents:

• Quick Tour
• Technology
• Documentation
• Development
• Release
• Download
• License

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

Technology

• The application is powered by Electron, with React, Redux, and NodeJs

• The bot uses a slightly modified version of node-irc to connect to game IRC.

Documentation

Available ressources:

• Connect to a multiplayer match
• Bot commands

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/
BEATCONNECT_CLIENT_GA_TRACKING_ID=ga-tracking-id
BEATCONNECT_CLIENT_API_KEY_V1=osu-api-key
BEATCONNECT_CLIENT_DISCORD_APP_ID=discord-app-id

Release

1. Create a branch named vX.X.X from latest master branch
2. Manually bump the version in package.json
3. Run yarn changelog
4. Commit and push
5. Open a pull request
6. Once the pull request is merged publish a new release on Github
7. A workflow should have been created and needs to be approved by an admin before run
8. Once the worflow is approved it will build the binaries artifacts for macos, windows and linux then it will upload them to the release you created
9. Voila! Users will now receive the new release via the auto update system

Download test

• Latest release available here

License

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