Skip to content

update readme to look a bit more professionally typed #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
g1-1-1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update readme to look a bit more professionally typed #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 20 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# Beemo

a javascript osu!bancho implementation for lazer because i can't typescript
Beemo is a Javascript bancho implementation for osu! lazer.

## Features

- Register & Login
- Score Submission
- Stats
- Score submission
- Statistics
- osu!direct
- Cross-Plattfrom support
- Global Leaderboard Ranking (Score)
- Cross-platform support
- Global leaderboard ranking (Score)


## Roadmap

- Make all modes compatible
- Multiplayer
- Spectator
- Chat (partly done, needs cleanups)
- Calculate & Display ranks (partly done)
- Chat (partly done, needs cleanup)
- Calculate & display ranks (partly done)
- Temporary pp system until a calculator gets updated/released
- Additional browser support / Frontend

Expand All @@ -38,32 +38,25 @@ a javascript osu!bancho implementation for lazer because i can't typescript

## Installation

This installation is required to have nginx and mongodb 6 installed.

This got tested with nodejs version 16.10

For a working certificate you need to be resposible at the moment.
You can always use tools like certbot or acme.sh

git clone the repository and edit the config
For installation, it is required to have nodejs (preferably 16.10), nginx and mongodb 6 installed.
For a certificate, you can use something like certbot.

`git clone` the repository and edit the configuration file as needed.
```bash
git clone https://github.com/calemy/beemo
cd beemo
nano config.example.js
mv config.example.js config.js
```

install all necessary dependencies using npm and start beemo using pm2

Install all necessary dependencies using npm and start beemo using pm2.
```bash
npm install
npm install -g pm2
pm2 start index.js --name Beemo
```

Add something like this to your nginx config.

```nginx
server {
listen 80;
Expand Down Expand Up @@ -95,10 +88,10 @@ server {
}
```

Restart nginx
Restart nginx to apply changes, and

```bash
sudo service nginx restart
sudo nginx -s reload -T && sudo nginx -s reload
```


Expand All @@ -112,35 +105,30 @@ Feel free to join as contributor!

#### What modes are supported?

Currently i'm focusing on making it work for standard.
Currently, Standard is the gamemode receiving service.
Other modes will most likely be added in the future.

#### When is this going to be done?
There is no guarantee that this is ever going to be finished,
but by the time lazer releases it might take aprox. another month or two.
but by the time lazer releases, it might take approx. another month or two.
Depending on the situation around this project.

#### Why is *insert issue here* not working?

It's still very early in development.
This project is still very early in development.

As for currently, i'm working alone on the project and therefore,
As for currently, I'm working alone on the project and therefore,
there might be things that are not done yet!

Additionally osu!lazer is not finished either
and might change a lot of things that might break the server.

#### Why are you using javascript and not *insert language here*?
#### Why are you using Javascript and not *insert language here*?

Simply because i like javascript and feel comfortable enough
Simply because I like javascript and feel comfortable enough
to write code this advanced in it. If you don't like it, it's not my problem
so deal with it. Also it's decently fast compared to languages like python.
so deal with it. Also, it's decently fast compared to languages like Python.
Yes, even the node v8 runtime.
## Optimizations

With Version 1 that came with the code-refactor we achieved to make the code easier to
maintain to what was possible for us to reduce the code to without losing important stuff.


## Feedback

Expand Down