Git Product home page Git Product logo

banchonet's Introduction

BanchoNET

A dotnet implementation of osu!bancho server.

Technologies

  • .NET 8
  • ASP.NET Core
  • MYSQL (MariaDB)

Progress

Go to the Projects section to see the progress of the BanchoNET project.

Features

  • Client login
  • Client register
  • Online users listing and statuses
  • Public and private chat
  • Banchobot

In development

  • Multiplayer lobbies
  • Scoreboards
  • Spectator mode
  • Clubs (clans)
  • osu!Direct

Building

Prerequisites

  • Dotnet SDK 8.0
  • MariaDB server
  • Nginx server

Building

To build the BanchoNET server, follow these steps:

  1. Clone the repository to your local machine.
git clone https://github.com/NovemoG/BanchoNET.git
  1. Navigate to the project directory.
cd BanchoNET
  1. Restore the project dependencies
dotnet restore
  1. Use the .NET build command to build the project.
dotnet build

This will create a build of your project in the ./bin/Debug/net8.0 directory.

  1. Navigate to the nginx configuration folder
cd /etc/nginx/sites-enabled
  1. Create banchonet configuration file
touch banchonet.conf
  1. Edit file with following config
server {
    listen 80;
    server_name c.DOMAIN;

    location / {
        proxy_pass https://0.0.0.0:5000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

server {
        listen 443 ssl;
        server_name c.DOMAIN;

        location / {
                proxy_pass https://0.0.0.0:5000;
                proxy_set_header Host $host;
                proxy_set_header X-Real-IP $remote_addr;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        }
}
server {
        listen 443 ssl;
        server_name osu.DOMAIN c4.DOMAIN;

        location / {
                proxy_pass https://0.0.0.0:5000;
                proxy_set_header Host $host;
                proxy_set_header X-Real-IP $remote_addr;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        }
}
  1. Replace DOMAIN with your domain.

  2. Add all subdomain records that are present in the config file above.

Usage

Running

To run the BanchoNET server, follow these steps:

  1. Navigate to the project directory.
cd BanchoNET
  1. Use the .NET run command to run the project.
dotnet run

This will start the BanchoNET server. You should see output indicating that the server is running.

Deployment

We are planning on adding docker support.

Contributing

  • Fork the Project
  • Create your Feature Branch git checkout -b feature/AmazingFeature
  • Commit your Changes git commit -m 'Add some AmazingFeature'
  • Push to the Branch git push origin feature/AmazingFeature
  • Open a Pull Request

License

Bancho.NET is licensed under the MIT License. Please see the LICENSE file for more information.

Acknowledgments

banchonet's People

Contributors

cossinus avatar folate avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.