Skip to content

Latest commit

 

History

History
60 lines (39 loc) · 1.71 KB

README.md

File metadata and controls

60 lines (39 loc) · 1.71 KB
Raw

NetPlay Index

Build Status Coverage Status Code style: black

A NetPlay Index server for Dolphin.

Features

  • Admin panel
  • Word backlisting
  • Host banning
  • Serverlist filtering

Requirements

Setup

Using Nix

Note: this requires Nix Flakes to be enabled on your system.

nix run github:dolphin-emu/netplay-index

Without Nix

This project uses Poetry for dependency management.

# Install dependencies (use --no-dev to skip optional dev dependencies).
poetry install

# Run tests (Optional)
GEOIP_DATABASE_PATH=testdata/GeoLite2-Country.mmdb poetry run pytest

# Creates a sysop account and gives you a randomly generated password (can be changed later)
poetry run netplay-index --add_sysop=SYSOP_NAME

# Run the server
poetry run netplay-index

Contributing

All PRs must be formatted using Black before submission and pass the CI.

Also remember to write some tests if you add any new code.
coveralls.io will report how your PR affects the project coverage.

License

Licensed under the GNU General Public License v3 or any later version at your option. See LICENSE.