Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opengsq/opengsq-master-server
This is an application that provides an API for searching game servers. The application supports the following games: BeamMP, Factorio, Palworld, Scum and The Front.
https://github.com/opengsq/opengsq-master-server
api beammp factorio flask master-server master-server-search opengsq palworld python scum thefront
Last synced: 23 days ago
JSON representation
This is an application that provides an API for searching game servers. The application supports the following games: BeamMP, Factorio, Palworld, Scum and The Front.
- Host: GitHub
- URL: https://github.com/opengsq/opengsq-master-server
- Owner: opengsq
- License: mit
- Created: 2024-03-10T02:35:31.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-29T22:32:21.000Z (8 months ago)
- Last Synced: 2024-04-29T23:39:00.440Z (8 months ago)
- Topics: api, beammp, factorio, flask, master-server, master-server-search, opengsq, palworld, python, scum, thefront
- Language: Python
- Homepage: https://master-server.opengsq.com
- Size: 97.7 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenGSQ Master Server Search API
[](https://github.com/opengsq/opengsq-master-server/actions/workflows/python-app.yml)
[](https://github.com/opengsq/opengsq-master-server/actions/workflows/docker-image.yml)
[](https://github.com/opengsq/opengsq-master-server/releases/)
[](https://github.com/opengsq/opengsq-master-server/blob/main/LICENSE)
This is an application that provides an API for searching game servers. The application supports the following games: BeamMP, Factorio, Palworld, Scum and The Front.
Try now: https://master-server.opengsq.com
## Usage
The application provides the following endpoints:
- `/beammp/search?host=&port=`
- `/factorio/search?host=&port=`
- `/palworld/search?host=&port=`
- `/scum/search?host=&port=`
- `/thefront/search?host=&port=`
Replace `` and `` with the host and port of the game server you want to search.
## Error Handling
The application will return a 400 error if the 'host' and 'port' parameters are not provided or if the 'port' parameter is not an integer. If no result is found, the application will return a 404 error.
## License
This project is licensed under the MIT License.
## Stargazers over time
[](https://starchart.cc/opengsq/opengsq-master-server)
---
## Development Setup
Follow these steps to set up your development environment:
1. Create a virtual environment:
```bash
python -m venv venv
```
2. Activate the virtual environment:
- On Windows, run: `venv\Scripts\activate`
- On Unix or MacOS, run: `source venv/bin/activate`
3. Install the required packages:
```bash
pip install -r requirements.txt
```
## Configuration
Copy the `.env.example` file to a new file named `.env` and update the variables as needed:
```bash
cp .env.example .env
```
Here's what each variable in the `.env` file represents:
| Variable | Description | Default Value | Best Practice |
| --- | --- | --- | --- |
| `DATABASE_URL` | The URL of your MongoDB database. | None | This is required. Make sure to keep this value secure and do not share it publicly. |
| `PORT` | The port number on which the Flask application will run. | `8000` | Choose a port that is not being used by other services. |
| `SECRET_KEY` | Flask application secret key. | None | This should be a random string. It is used for session management in Flask. Keep this value secure. |
| `USERNAME` | The username for Flask-MonitoringDashboard. | `admin` | Change this to a unique username. |
| `PASSWORD` | The password for Flask-MonitoringDashboard. | `admin` | Change this to a strong, unique password. |
| `SECURITY_TOKEN` | The security token for Flask-MonitoringDashboard. | `cc83733cb0af8b884ff6577086b87909` | This should be a random string. Keep this value secure. |
| `FACTORIO_USERNAME` | The username for Factorio. | None | Set this to your Factorio username. |
| `FACTORIO_TOKEN` | The token for Factorio. | None | This should be your Factorio token. Keep this value secure. |
Remember, it's important to keep all sensitive information such as `DATABASE_URL`, `SECRET_KEY`, `PASSWORD`, `SECURITY_TOKEN`, and `FACTORIO_TOKEN` secure and not to share them publicly or commit them to version control. It's a good practice to use environment variables or a secure method to store these values.
## Running the Application (Development)
You can start the scheduled task or run the Flask application in debug mode:
- Start the scheduled task:
```bash
python main.py
```
- Run Flask in debug mode:
```bash
python app.py
```
- Run the protocol:
```bash
python -m protocol.BeamMP
```
---
## Self-Hosting
[](https://hub.docker.com/r/opengsq/opengsq-master-server)
You can use Docker Compose to self-host the application. Here's how:
1. Create a `docker-compose.yml` file [docker-compose.yml example](/docker-compose.prod.yml)
2. Run the following command to start the application:
```bash
docker compose up -d
```