dolphin-emu/netplay-index
1
0
Fork 0
mirror of https://github.com/dolphin-emu/netplay-index.git synced 2024-11-26 18:21:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
A NetPlay Index server for Dolphin
130 Commits 3 Branches 0 Tags 3.5 MiB
Python 78.1%
HTML 19.1%
Nix 1.5%
JavaScript 0.9%
CSS 0.4%
master
Go to file
OatmealDome a102293eb4 flake: Raise async test timeout to 30 seconds 
I work on a virtual machine, and it doesn't seem to be fast enough for the standard 5 second timeout somehow.
2024-01-30 23:46:39 -05:00
.github/workflows ci: add a workflow for building the Nix Flake 2022-08-20 04:44:54 +02:00
netplay_index netplay_index: add a new bind address option, default to localhost 2022-09-05 10:01:29 +02:00
testdata tests: provide a vendored version of GeoLite2 2022-08-20 04:16:23 +02:00
.coveragerc Update .coveragerc 2019-04-09 12:23:14 +02:00
.gitignore tests: provide a vendored version of GeoLite2 2022-08-20 04:16:23 +02:00
CODE_OF_CONDUCT.md Add ref to Dolphin's Code of Conduct 2023-01-02 11:22:33 +01:00
flake.lock flake.lock: Update 2024-01-30 18:17:17 -05:00
flake.nix flake: Raise async test timeout to 30 seconds 2024-01-30 23:46:39 -05:00
LICENSE Initial commit 2019-04-02 16:24:10 +02:00
poetry.lock build(deps): bump certifi from 2022.9.24 to 2022.12.7 2023-01-10 14:26:37 +01:00
pyproject.toml deps: bump coverage and coveralls, add pytest-cov 2022-08-20 03:42:56 +02:00
README.md Add Nix Flake support (using poetry2nix) 2022-08-20 04:37:46 +02:00

README.md

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.