Binato/README.md

50 lines
1.8 KiB
Markdown
Raw Normal View History

2021-02-12 23:39:37 +00:00
# Binato [![CodeFactor](https://www.codefactor.io/repository/github/tgpethan/binato/badge/master)](https://www.codefactor.io/repository/github/tgpethan/binato/overview/master)
2020-08-28 09:15:04 +01:00
An implementation of osu!bancho in Javascript
2021-02-12 23:36:35 +00:00
2020-08-28 09:15:04 +01:00
<hr>
### Features:
2020-09-02 11:31:06 +01:00
- Multiplayer + Invites
2020-08-28 09:15:04 +01:00
- Spectator
2021-03-09 18:24:34 +00:00
- Tourney Client
2020-09-02 12:19:19 +01:00
- User Panel
- Friends List
2020-08-28 09:15:04 +01:00
- Chat & Channels
2020-09-02 10:56:23 +01:00
- Private Messages
2021-01-26 12:33:27 +00:00
- Minimum Viable Product of a bot
- For a command list check [BotCommandHandler](https://github.com/tgpethan/Binato/blob/master/server/BotCommandHandler.js) or use !help on a live server
2020-08-28 09:15:04 +01:00
2021-01-29 04:23:49 +00:00
### [List of bugs](https://github.com/tgpethan/Binato/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
2020-08-28 09:15:04 +01:00
## How to connect:
### 2013 - Stable Fallback (2015 / 2016 ?):
Stable fallback uses HTTP so for that you just need to direct it to the server<br>
You can do this using the hosts file
Location on Linux: /etc/hosts<br>
Location on Windows: C:/Windows/system32/drivers/etc/hosts
Add an entry in the hosts file that looks like the following:
```
<server_ip> osu.ppy.sh c.ppy.sh c1.ppy.sh
```
Where <server_ip> is the IP Address of the server hosting the bancho server
2021-03-09 16:02:03 +00:00
### 2016 - Early 2021:
2020-08-28 09:15:04 +01:00
Versions of osu! past Stable Fallback use HTTPS and as such you'll have to create a self signed certificate and make the server identify as ppy.sh<br>
2021-03-09 18:21:14 +00:00
In 2018 there were also new subdomains added which are:
2020-08-28 09:15:04 +01:00
- c2.ppy.sh
- c3.ppy.sh
- c4.ppy.sh
- c5.ppy.sh
- c6.ppy.sh
- ce.ppy.sh
2021-03-09 16:02:03 +00:00
2021-03-09 16:02:14 +00:00
### Now:
2021-03-09 18:22:04 +00:00
Recently on cuttingedge the -devserver flag has been added which can be passed to the client to connect to a specific server.
2020-08-28 09:15:04 +01:00
## Things not included in this repo:
### Profile Pictures:
Profile pictures can be handled by any standard HTTP server, there is also one I made for the task here: [Binato-ProfilePicture](https://github.com/tgpethan/Binato-ProfilePicture)